<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>bkn.bibtex.bibliography</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="bkn.bibtex-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/bibkn/">bkn.bibtex</a></th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        Package&nbsp;bkn ::
        <a href="bkn.bibtex-module.html">Package&nbsp;bibtex</a> ::
        Module&nbsp;bibliography
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="bkn.bibtex.bibliography-pysrc.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<h1 class="epydoc">Source Code for <a href="bkn.bibtex.bibliography-module.html">Module bkn.bibtex.bibliography</a></h1>
<pre class="py-src">
<a name="L1"></a><tt class="py-lineno">   1</tt>  <tt class="py-line"><tt class="py-docstring">'''Provides a bibliography class with methods to load BibTeX data.</tt> </tt>
<a name="L2"></a><tt class="py-lineno">   2</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L3"></a><tt class="py-lineno">   3</tt>  <tt class="py-line"><tt class="py-docstring">@copyright: (c) 2009-2010, Benjamin Kalish</tt> </tt>
<a name="L4"></a><tt class="py-lineno">   4</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L5"></a><tt class="py-lineno">   5</tt>  <tt class="py-line"><tt class="py-docstring">@license:</tt> </tt>
<a name="L6"></a><tt class="py-lineno">   6</tt>  <tt class="py-line"><tt class="py-docstring">    This program is free software; you can redistribute it and/or modify</tt> </tt>
<a name="L7"></a><tt class="py-lineno">   7</tt>  <tt class="py-line"><tt class="py-docstring">    it under the terms of the GNU General Public License as published by</tt> </tt>
<a name="L8"></a><tt class="py-lineno">   8</tt>  <tt class="py-line"><tt class="py-docstring">    the Free Software Foundation; either version 2 of the License, or</tt> </tt>
<a name="L9"></a><tt class="py-lineno">   9</tt>  <tt class="py-line"><tt class="py-docstring">    (at your option) any later version.</tt> </tt>
<a name="L10"></a><tt class="py-lineno">  10</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L11"></a><tt class="py-lineno">  11</tt>  <tt class="py-line"><tt class="py-docstring">    This program is distributed in the hope that it will be useful, but</tt> </tt>
<a name="L12"></a><tt class="py-lineno">  12</tt>  <tt class="py-line"><tt class="py-docstring">    WITHOUT ANY WARRANTY; without even the implied warranty of</tt> </tt>
<a name="L13"></a><tt class="py-lineno">  13</tt>  <tt class="py-line"><tt class="py-docstring">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU</tt> </tt>
<a name="L14"></a><tt class="py-lineno">  14</tt>  <tt class="py-line"><tt class="py-docstring">    General Public License for more details.</tt> </tt>
<a name="L15"></a><tt class="py-lineno">  15</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L16"></a><tt class="py-lineno">  16</tt>  <tt class="py-line"><tt class="py-docstring">@todo:</tt> </tt>
<a name="L17"></a><tt class="py-lineno">  17</tt>  <tt class="py-line"><tt class="py-docstring">    write module level documentation</tt> </tt>
<a name="L18"></a><tt class="py-lineno">  18</tt>  <tt class="py-line"><tt class="py-docstring">@todo:</tt> </tt>
<a name="L19"></a><tt class="py-lineno">  19</tt>  <tt class="py-line"><tt class="py-docstring">    test all file and string input with a variety of string encodings.</tt> </tt>
<a name="L20"></a><tt class="py-lineno">  20</tt>  <tt class="py-line"><tt class="py-docstring">'''</tt> </tt>
<a name="L21"></a><tt class="py-lineno">  21</tt>  <tt class="py-line"><tt class="py-comment"># standard libraries</tt> </tt>
<a name="L22"></a><tt class="py-lineno">  22</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">codecs</tt> </tt>
<a name="L23"></a><tt class="py-lineno">  23</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">copy</tt> </tt>
<a name="L24"></a><tt class="py-lineno">  24</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">json</tt> </tt>
<a name="L25"></a><tt class="py-lineno">  25</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">locale</tt> </tt>
<a name="L26"></a><tt class="py-lineno">  26</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">os</tt> </tt>
<a name="L27"></a><tt class="py-lineno">  27</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">re</tt> </tt>
<a name="L28"></a><tt class="py-lineno">  28</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">subprocess</tt> </tt>
<a name="L29"></a><tt class="py-lineno">  29</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">sys</tt> </tt>
<a name="L30"></a><tt class="py-lineno">  30</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">tempfile</tt> </tt>
<a name="L31"></a><tt class="py-lineno">  31</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">types</tt> </tt>
<a name="L32"></a><tt class="py-lineno">  32</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">urllib</tt> </tt>
<a name="L33"></a><tt class="py-lineno">  33</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">urlparse</tt> </tt>
<a name="L34"></a><tt class="py-lineno">  34</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">warnings</tt> </tt>
<a name="L35"></a><tt class="py-lineno">  35</tt>  <tt class="py-line"> </tt>
<a name="L36"></a><tt class="py-lineno">  36</tt>  <tt class="py-line"><tt class="py-comment"># 3rd party libraries</tt> </tt>
<a name="L37"></a><tt class="py-lineno">  37</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">simpleparse</tt><tt class="py-op">.</tt><tt id="link-0" class="py-name" targets="Module bkn.bibtex.error=bkn.bibtex.error-module.html"><a title="bkn.bibtex.error" class="py-name" href="#" onclick="return doclink('link-0', 'error', 'link-0');">error</a></tt> <tt class="py-keyword">import</tt> <tt class="py-name">ParserSyntaxError</tt> </tt>
<a name="L38"></a><tt class="py-lineno">  38</tt>  <tt class="py-line"> </tt>
<a name="L39"></a><tt class="py-lineno">  39</tt>  <tt class="py-line"><tt class="py-comment"># BKN libraries</tt> </tt>
<a name="L40"></a><tt class="py-lineno">  40</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">bkn</tt><tt class="py-op">.</tt><tt id="link-1" class="py-name" targets="Package bkn.bibtex=bkn.bibtex-module.html,Module bkn.bibtex.bibtex=bkn.bibtex.bibtex-module.html"><a title="bkn.bibtex
bkn.bibtex.bibtex" class="py-name" href="#" onclick="return doclink('link-1', 'bibtex', 'link-1');">bibtex</a></tt><tt class="py-op">.</tt><tt class="py-name">_bibtex_parser</tt> <tt class="py-keyword">import</tt> <tt class="py-name">BIBTEX_PARSER</tt> </tt>
<a name="L41"></a><tt class="py-lineno">  41</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">bkn</tt><tt class="py-op">.</tt><tt id="link-2" class="py-name"><a title="bkn.bibtex
bkn.bibtex.bibtex" class="py-name" href="#" onclick="return doclink('link-2', 'bibtex', 'link-1');">bibtex</a></tt><tt class="py-op">.</tt><tt class="py-name">_bibtex_parser</tt> <tt class="py-keyword">import</tt> <tt class="py-name">BibtexProcessor</tt> </tt>
<a name="L42"></a><tt class="py-lineno">  42</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">bkn</tt><tt class="py-op">.</tt><tt id="link-3" class="py-name"><a title="bkn.bibtex
bkn.bibtex.bibtex" class="py-name" href="#" onclick="return doclink('link-3', 'bibtex', 'link-1');">bibtex</a></tt><tt class="py-op">.</tt><tt id="link-4" class="py-name" targets="Module bkn.bibtex.utilities=bkn.bibtex.utilities-module.html"><a title="bkn.bibtex.utilities" class="py-name" href="#" onclick="return doclink('link-4', 'utilities', 'link-4');">utilities</a></tt> <tt class="py-keyword">import</tt> <tt id="link-5" class="py-name" targets="Function bkn.bibtex.utilities.assert_objects_are_unicode()=bkn.bibtex.utilities-module.html#assert_objects_are_unicode"><a title="bkn.bibtex.utilities.assert_objects_are_unicode" class="py-name" href="#" onclick="return doclink('link-5', 'assert_objects_are_unicode', 'link-5');">assert_objects_are_unicode</a></tt> </tt>
<a name="L43"></a><tt class="py-lineno">  43</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">bkn</tt><tt class="py-op">.</tt><tt id="link-6" class="py-name"><a title="bkn.bibtex
bkn.bibtex.bibtex" class="py-name" href="#" onclick="return doclink('link-6', 'bibtex', 'link-1');">bibtex</a></tt><tt class="py-op">.</tt><tt id="link-7" class="py-name"><a title="bkn.bibtex.utilities" class="py-name" href="#" onclick="return doclink('link-7', 'utilities', 'link-4');">utilities</a></tt> <tt class="py-keyword">import</tt> <tt id="link-8" class="py-name" targets="Function bkn.bibtex.utilities.ensure_objects_are_unicode()=bkn.bibtex.utilities-module.html#ensure_objects_are_unicode"><a title="bkn.bibtex.utilities.ensure_objects_are_unicode" class="py-name" href="#" onclick="return doclink('link-8', 'ensure_objects_are_unicode', 'link-8');">ensure_objects_are_unicode</a></tt> </tt>
<a name="L44"></a><tt class="py-lineno">  44</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">bkn</tt><tt class="py-op">.</tt><tt id="link-9" class="py-name"><a title="bkn.bibtex
bkn.bibtex.bibtex" class="py-name" href="#" onclick="return doclink('link-9', 'bibtex', 'link-1');">bibtex</a></tt><tt class="py-op">.</tt><tt id="link-10" class="py-name"><a title="bkn.bibtex.error" class="py-name" href="#" onclick="return doclink('link-10', 'error', 'link-0');">error</a></tt> <tt class="py-keyword">import</tt> <tt id="link-11" class="py-name" targets="Class bkn.bibtex.error.AttributeCollisionWarning=bkn.bibtex.error.AttributeCollisionWarning-class.html"><a title="bkn.bibtex.error.AttributeCollisionWarning" class="py-name" href="#" onclick="return doclink('link-11', 'AttributeCollisionWarning', 'link-11');">AttributeCollisionWarning</a></tt> </tt>
<a name="L45"></a><tt class="py-lineno">  45</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">bkn</tt><tt class="py-op">.</tt><tt id="link-12" class="py-name"><a title="bkn.bibtex
bkn.bibtex.bibtex" class="py-name" href="#" onclick="return doclink('link-12', 'bibtex', 'link-1');">bibtex</a></tt><tt class="py-op">.</tt><tt id="link-13" class="py-name"><a title="bkn.bibtex.error" class="py-name" href="#" onclick="return doclink('link-13', 'error', 'link-0');">error</a></tt> <tt class="py-keyword">import</tt> <tt id="link-14" class="py-name" targets="Class bkn.bibtex.error.BadAttributeNameError=bkn.bibtex.error.BadAttributeNameError-class.html"><a title="bkn.bibtex.error.BadAttributeNameError" class="py-name" href="#" onclick="return doclink('link-14', 'BadAttributeNameError', 'link-14');">BadAttributeNameError</a></tt> </tt>
<a name="L46"></a><tt class="py-lineno">  46</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">bkn</tt><tt class="py-op">.</tt><tt id="link-15" class="py-name"><a title="bkn.bibtex
bkn.bibtex.bibtex" class="py-name" href="#" onclick="return doclink('link-15', 'bibtex', 'link-1');">bibtex</a></tt><tt class="py-op">.</tt><tt id="link-16" class="py-name"><a title="bkn.bibtex.error" class="py-name" href="#" onclick="return doclink('link-16', 'error', 'link-0');">error</a></tt> <tt class="py-keyword">import</tt> <tt id="link-17" class="py-name" targets="Class bkn.bibtex.error.BibFileSyntaxError=bkn.bibtex.error.BibFileSyntaxError-class.html"><a title="bkn.bibtex.error.BibFileSyntaxError" class="py-name" href="#" onclick="return doclink('link-17', 'BibFileSyntaxError', 'link-17');">BibFileSyntaxError</a></tt> </tt>
<a name="L47"></a><tt class="py-lineno">  47</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">bkn</tt><tt class="py-op">.</tt><tt id="link-18" class="py-name"><a title="bkn.bibtex
bkn.bibtex.bibtex" class="py-name" href="#" onclick="return doclink('link-18', 'bibtex', 'link-1');">bibtex</a></tt><tt class="py-op">.</tt><tt id="link-19" class="py-name"><a title="bkn.bibtex.error" class="py-name" href="#" onclick="return doclink('link-19', 'error', 'link-0');">error</a></tt> <tt class="py-keyword">import</tt> <tt id="link-20" class="py-name" targets="Class bkn.bibtex.error.BibTeXError=bkn.bibtex.error.BibTeXError-class.html"><a title="bkn.bibtex.error.BibTeXError" class="py-name" href="#" onclick="return doclink('link-20', 'BibTeXError', 'link-20');">BibTeXError</a></tt> </tt>
<a name="L48"></a><tt class="py-lineno">  48</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">bkn</tt><tt class="py-op">.</tt><tt id="link-21" class="py-name"><a title="bkn.bibtex
bkn.bibtex.bibtex" class="py-name" href="#" onclick="return doclink('link-21', 'bibtex', 'link-1');">bibtex</a></tt><tt class="py-op">.</tt><tt id="link-22" class="py-name"><a title="bkn.bibtex.error" class="py-name" href="#" onclick="return doclink('link-22', 'error', 'link-0');">error</a></tt> <tt class="py-keyword">import</tt> <tt id="link-23" class="py-name" targets="Class bkn.bibtex.error.BKNBibtexError=bkn.bibtex.error.BKNBibtexError-class.html"><a title="bkn.bibtex.error.BKNBibtexError" class="py-name" href="#" onclick="return doclink('link-23', 'BKNBibtexError', 'link-23');">BKNBibtexError</a></tt> </tt>
<a name="L49"></a><tt class="py-lineno">  49</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">bkn</tt><tt class="py-op">.</tt><tt id="link-24" class="py-name"><a title="bkn.bibtex
bkn.bibtex.bibtex" class="py-name" href="#" onclick="return doclink('link-24', 'bibtex', 'link-1');">bibtex</a></tt><tt class="py-op">.</tt><tt id="link-25" class="py-name"><a title="bkn.bibtex.error" class="py-name" href="#" onclick="return doclink('link-25', 'error', 'link-0');">error</a></tt> <tt class="py-keyword">import</tt> <tt id="link-26" class="py-name" targets="Class bkn.bibtex.error.BKNBibtexWarning=bkn.bibtex.error.BKNBibtexWarning-class.html"><a title="bkn.bibtex.error.BKNBibtexWarning" class="py-name" href="#" onclick="return doclink('link-26', 'BKNBibtexWarning', 'link-26');">BKNBibtexWarning</a></tt> </tt>
<a name="L50"></a><tt class="py-lineno">  50</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">bkn</tt><tt class="py-op">.</tt><tt id="link-27" class="py-name"><a title="bkn.bibtex
bkn.bibtex.bibtex" class="py-name" href="#" onclick="return doclink('link-27', 'bibtex', 'link-1');">bibtex</a></tt><tt class="py-op">.</tt><tt id="link-28" class="py-name"><a title="bkn.bibtex.error" class="py-name" href="#" onclick="return doclink('link-28', 'error', 'link-0');">error</a></tt> <tt class="py-keyword">import</tt> <tt id="link-29" class="py-name" targets="Class bkn.bibtex.error.FormatNotSupportedError=bkn.bibtex.error.FormatNotSupportedError-class.html"><a title="bkn.bibtex.error.FormatNotSupportedError" class="py-name" href="#" onclick="return doclink('link-29', 'FormatNotSupportedError', 'link-29');">FormatNotSupportedError</a></tt> </tt>
<a name="L51"></a><tt class="py-lineno">  51</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">bkn</tt><tt class="py-op">.</tt><tt id="link-30" class="py-name"><a title="bkn.bibtex
bkn.bibtex.bibtex" class="py-name" href="#" onclick="return doclink('link-30', 'bibtex', 'link-1');">bibtex</a></tt><tt class="py-op">.</tt><tt id="link-31" class="py-name"><a title="bkn.bibtex.error" class="py-name" href="#" onclick="return doclink('link-31', 'error', 'link-0');">error</a></tt> <tt class="py-keyword">import</tt> <tt id="link-32" class="py-name" targets="Class bkn.bibtex.error.InvalidRecordError=bkn.bibtex.error.InvalidRecordError-class.html"><a title="bkn.bibtex.error.InvalidRecordError" class="py-name" href="#" onclick="return doclink('link-32', 'InvalidRecordError', 'link-32');">InvalidRecordError</a></tt> </tt>
<a name="L52"></a><tt class="py-lineno">  52</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">bkn</tt><tt class="py-op">.</tt><tt id="link-33" class="py-name"><a title="bkn.bibtex
bkn.bibtex.bibtex" class="py-name" href="#" onclick="return doclink('link-33', 'bibtex', 'link-1');">bibtex</a></tt><tt class="py-op">.</tt><tt id="link-34" class="py-name"><a title="bkn.bibtex.error" class="py-name" href="#" onclick="return doclink('link-34', 'error', 'link-0');">error</a></tt> <tt class="py-keyword">import</tt> <tt id="link-35" class="py-name" targets="Class bkn.bibtex.error.InvalidReferenceError=bkn.bibtex.error.InvalidReferenceError-class.html"><a title="bkn.bibtex.error.InvalidReferenceError" class="py-name" href="#" onclick="return doclink('link-35', 'InvalidReferenceError', 'link-35');">InvalidReferenceError</a></tt> </tt>
<a name="L53"></a><tt class="py-lineno">  53</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">bkn</tt><tt class="py-op">.</tt><tt id="link-36" class="py-name"><a title="bkn.bibtex
bkn.bibtex.bibtex" class="py-name" href="#" onclick="return doclink('link-36', 'bibtex', 'link-1');">bibtex</a></tt><tt class="py-op">.</tt><tt id="link-37" class="py-name"><a title="bkn.bibtex.error" class="py-name" href="#" onclick="return doclink('link-37', 'error', 'link-0');">error</a></tt> <tt class="py-keyword">import</tt> <tt id="link-38" class="py-name" targets="Class bkn.bibtex.error.InvalidResponseError=bkn.bibtex.error.InvalidResponseError-class.html"><a title="bkn.bibtex.error.InvalidResponseError" class="py-name" href="#" onclick="return doclink('link-38', 'InvalidResponseError', 'link-38');">InvalidResponseError</a></tt> </tt>
<a name="L54"></a><tt class="py-lineno">  54</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">bkn</tt><tt class="py-op">.</tt><tt id="link-39" class="py-name"><a title="bkn.bibtex
bkn.bibtex.bibtex" class="py-name" href="#" onclick="return doclink('link-39', 'bibtex', 'link-1');">bibtex</a></tt><tt class="py-op">.</tt><tt id="link-40" class="py-name"><a title="bkn.bibtex.error" class="py-name" href="#" onclick="return doclink('link-40', 'error', 'link-0');">error</a></tt> <tt class="py-keyword">import</tt> <tt id="link-41" class="py-name" targets="Class bkn.bibtex.error.RecordNotFoundError=bkn.bibtex.error.RecordNotFoundError-class.html"><a title="bkn.bibtex.error.RecordNotFoundError" class="py-name" href="#" onclick="return doclink('link-41', 'RecordNotFoundError', 'link-41');">RecordNotFoundError</a></tt> </tt>
<a name="L55"></a><tt class="py-lineno">  55</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">bkn</tt><tt class="py-op">.</tt><tt id="link-42" class="py-name"><a title="bkn.bibtex
bkn.bibtex.bibtex" class="py-name" href="#" onclick="return doclink('link-42', 'bibtex', 'link-1');">bibtex</a></tt><tt class="py-op">.</tt><tt id="link-43" class="py-name"><a title="bkn.bibtex.utilities" class="py-name" href="#" onclick="return doclink('link-43', 'utilities', 'link-4');">utilities</a></tt> <tt class="py-keyword">import</tt> <tt id="link-44" class="py-name" targets="Function bkn.bibtex.utilities.which()=bkn.bibtex.utilities-module.html#which"><a title="bkn.bibtex.utilities.which" class="py-name" href="#" onclick="return doclink('link-44', 'which', 'link-44');">which</a></tt> </tt>
<a name="L56"></a><tt class="py-lineno">  56</tt>  <tt class="py-line"> </tt>
<a name="L57"></a><tt class="py-lineno">  57</tt>  <tt class="py-line"> </tt>
<a name="L58"></a><tt class="py-lineno">  58</tt>  <tt class="py-line"><tt class="py-comment"># Module level constants</tt> </tt>
<a name="L59"></a><tt class="py-lineno">  59</tt>  <tt class="py-line"> </tt>
<a name="L60"></a><tt class="py-lineno">  60</tt>  <tt class="py-line"><tt id="link-45" class="py-name" targets="Variable bkn.bibtex.bibliography.BIBTEX_FIELDS=bkn.bibtex.bibliography-module.html#BIBTEX_FIELDS"><a title="bkn.bibtex.bibliography.BIBTEX_FIELDS" class="py-name" href="#" onclick="return doclink('link-45', 'BIBTEX_FIELDS', 'link-45');">BIBTEX_FIELDS</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-string">'address'</tt><tt class="py-op">,</tt> <tt class="py-string">'annote'</tt><tt class="py-op">,</tt> <tt class="py-string">'author'</tt><tt class="py-op">,</tt> <tt class="py-string">'booktitle'</tt><tt class="py-op">,</tt> <tt class="py-string">'chapter'</tt><tt class="py-op">,</tt>  </tt>
<a name="L61"></a><tt class="py-lineno">  61</tt>  <tt class="py-line">    <tt class="py-string">'crossref'</tt><tt class="py-op">,</tt> <tt class="py-string">'edition'</tt><tt class="py-op">,</tt> <tt class="py-string">'editor'</tt><tt class="py-op">,</tt> <tt class="py-string">'howpublished'</tt><tt class="py-op">,</tt> <tt class="py-string">'institution'</tt><tt class="py-op">,</tt> <tt class="py-string">'journal'</tt><tt class="py-op">,</tt>  </tt>
<a name="L62"></a><tt class="py-lineno">  62</tt>  <tt class="py-line">    <tt class="py-string">'key'</tt><tt class="py-op">,</tt> <tt class="py-string">'month'</tt><tt class="py-op">,</tt> <tt class="py-string">'note'</tt><tt class="py-op">,</tt> <tt class="py-string">'number'</tt><tt class="py-op">,</tt> <tt class="py-string">'organization'</tt><tt class="py-op">,</tt> <tt class="py-string">'pages'</tt><tt class="py-op">,</tt> <tt class="py-string">'publisher'</tt><tt class="py-op">,</tt> </tt>
<a name="L63"></a><tt class="py-lineno">  63</tt>  <tt class="py-line">    <tt class="py-string">'school'</tt><tt class="py-op">,</tt> <tt class="py-string">'series'</tt><tt class="py-op">,</tt> <tt class="py-string">'title'</tt><tt class="py-op">,</tt> <tt class="py-string">'type'</tt><tt class="py-op">,</tt> <tt class="py-string">'volume'</tt><tt class="py-op">,</tt> <tt class="py-string">'year'</tt><tt class="py-op">]</tt> </tt>
<a name="L64"></a><tt class="py-lineno">  64</tt>  <tt class="py-line"><tt class="py-string">'''A list of the standard fields used by BibTeX.</tt> </tt>
<a name="L65"></a><tt class="py-lineno">  65</tt>  <tt class="py-line"><tt class="py-string"></tt> </tt>
<a name="L66"></a><tt class="py-lineno">  66</tt>  <tt class="py-line"><tt class="py-string">Field names are taken from I{BibTeXing} by Oren Patashnick (1988).</tt> </tt>
<a name="L67"></a><tt class="py-lineno">  67</tt>  <tt class="py-line"><tt class="py-string"></tt> </tt>
<a name="L68"></a><tt class="py-lineno">  68</tt>  <tt class="py-line"><tt class="py-string">@type: C{list} of C{str}s</tt> </tt>
<a name="L69"></a><tt class="py-lineno">  69</tt>  <tt class="py-line"><tt class="py-string">@note: this constant was formerly named STANDARD_FIELDS.</tt> </tt>
<a name="L70"></a><tt class="py-lineno">  70</tt>  <tt class="py-line"><tt class="py-string">'''</tt> </tt>
<a name="L71"></a><tt class="py-lineno">  71</tt>  <tt class="py-line"> </tt>
<a name="L72"></a><tt class="py-lineno">  72</tt>  <tt class="py-line"><tt id="link-46" class="py-name" targets="Variable bkn.bibtex.bibliography.BIBTEX_TYPES=bkn.bibtex.bibliography-module.html#BIBTEX_TYPES"><a title="bkn.bibtex.bibliography.BIBTEX_TYPES" class="py-name" href="#" onclick="return doclink('link-46', 'BIBTEX_TYPES', 'link-46');">BIBTEX_TYPES</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-string">'article'</tt><tt class="py-op">,</tt> <tt class="py-string">'book'</tt><tt class="py-op">,</tt> <tt class="py-string">'booklet'</tt><tt class="py-op">,</tt> <tt class="py-string">'conference'</tt><tt class="py-op">,</tt> <tt class="py-string">'inbook'</tt><tt class="py-op">,</tt> </tt>
<a name="L73"></a><tt class="py-lineno">  73</tt>  <tt class="py-line">    <tt class="py-string">'incollection'</tt><tt class="py-op">,</tt> <tt class="py-string">'inproceedings'</tt><tt class="py-op">,</tt> <tt class="py-string">'manual'</tt><tt class="py-op">,</tt> <tt class="py-string">'mastersthesis'</tt><tt class="py-op">,</tt> <tt class="py-string">'misc'</tt><tt class="py-op">,</tt> </tt>
<a name="L74"></a><tt class="py-lineno">  74</tt>  <tt class="py-line">    <tt class="py-string">'phdthesis'</tt><tt class="py-op">,</tt> <tt class="py-string">'proceedings'</tt><tt class="py-op">,</tt> <tt class="py-string">'techreport'</tt><tt class="py-op">,</tt> <tt class="py-string">'unpublished'</tt><tt class="py-op">]</tt> </tt>
<a name="L75"></a><tt class="py-lineno">  75</tt>  <tt class="py-line"><tt class="py-string">'''A list of the standard entry types used by BibTeX</tt> </tt>
<a name="L76"></a><tt class="py-lineno">  76</tt>  <tt class="py-line"><tt class="py-string"></tt> </tt>
<a name="L77"></a><tt class="py-lineno">  77</tt>  <tt class="py-line"><tt class="py-string">Entry types are taken from I{BibTeXing} by Oren Patashnick (1988).</tt> </tt>
<a name="L78"></a><tt class="py-lineno">  78</tt>  <tt class="py-line"><tt class="py-string"></tt> </tt>
<a name="L79"></a><tt class="py-lineno">  79</tt>  <tt class="py-line"><tt class="py-string">@type: C{list} of C{str}s</tt> </tt>
<a name="L80"></a><tt class="py-lineno">  80</tt>  <tt class="py-line"><tt class="py-string">'''</tt> </tt>
<a name="L81"></a><tt class="py-lineno">  81</tt>  <tt class="py-line"> </tt>
<a name="L82"></a><tt class="py-lineno">  82</tt>  <tt class="py-line"><tt id="link-47" class="py-name" targets="Variable bkn.bibtex.bibliography.BIBTEX_WARNING_REGEX=bkn.bibtex.bibliography-module.html#BIBTEX_WARNING_REGEX"><a title="bkn.bibtex.bibliography.BIBTEX_WARNING_REGEX" class="py-name" href="#" onclick="return doclink('link-47', 'BIBTEX_WARNING_REGEX', 'link-47');">BIBTEX_WARNING_REGEX</a></tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">compile</tt><tt class="py-op">(</tt><tt class="py-string">r'Warning--(.*) in (.*)$'</tt><tt class="py-op">)</tt> </tt>
<a name="L83"></a><tt class="py-lineno">  83</tt>  <tt class="py-line"><tt class="py-string">'''A regular expression which matches the warning lines which BibTeX prints to standard out.</tt> </tt>
<a name="L84"></a><tt class="py-lineno">  84</tt>  <tt class="py-line"><tt class="py-string"></tt> </tt>
<a name="L85"></a><tt class="py-lineno">  85</tt>  <tt class="py-line"><tt class="py-string">The expression contains two groups: the first group describes the</tt> </tt>
<a name="L86"></a><tt class="py-lineno">  86</tt>  <tt class="py-line"><tt class="py-string">problem, the second group contains citation key of the entry in which it</tt> </tt>
<a name="L87"></a><tt class="py-lineno">  87</tt>  <tt class="py-line"><tt class="py-string">was encountered.</tt> </tt>
<a name="L88"></a><tt class="py-lineno">  88</tt>  <tt class="py-line"><tt class="py-string"></tt> </tt>
<a name="L89"></a><tt class="py-lineno">  89</tt>  <tt class="py-line"><tt class="py-string">@type: C{re.RegexObject}'''</tt> </tt>
<a name="L90"></a><tt class="py-lineno">  90</tt>  <tt class="py-line"> </tt>
<a name="L91"></a><tt class="py-lineno">  91</tt>  <tt class="py-line"><tt id="link-48" class="py-name" targets="Variable bkn.bibtex.bibliography.DEFAULT_ENCODING=bkn.bibtex.bibliography-module.html#DEFAULT_ENCODING"><a title="bkn.bibtex.bibliography.DEFAULT_ENCODING" class="py-name" href="#" onclick="return doclink('link-48', 'DEFAULT_ENCODING', 'link-48');">DEFAULT_ENCODING</a></tt> <tt class="py-op">=</tt> <tt class="py-name">locale</tt><tt class="py-op">.</tt><tt class="py-name">getpreferredencoding</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L92"></a><tt class="py-lineno">  92</tt>  <tt class="py-line"><tt class="py-string">'''The default text encoding as returned by locale.getpreferredencoding().'''</tt> </tt>
<a name="L93"></a><tt class="py-lineno">  93</tt>  <tt class="py-line"> </tt>
<a name="L94"></a><tt class="py-lineno">  94</tt>  <tt class="py-line"><tt id="link-49" class="py-name" targets="Variable bkn.bibtex.bibliography.bib_cache=bkn.bibtex.bibliography-module.html#bib_cache"><a title="bkn.bibtex.bibliography.bib_cache" class="py-name" href="#" onclick="return doclink('link-49', 'bib_cache', 'link-49');">bib_cache</a></tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L95"></a><tt class="py-lineno">  95</tt>  <tt class="py-line"><tt class="py-string">'''A cache of bibs which have been opened.</tt> </tt>
<a name="L96"></a><tt class="py-lineno">  96</tt>  <tt class="py-line"><tt class="py-string"></tt> </tt>
<a name="L97"></a><tt class="py-lineno">  97</tt>  <tt class="py-line"><tt class="py-string">This caches will be used when looking up an record by id using</tt> </tt>
<a name="L98"></a><tt class="py-lineno">  98</tt>  <tt class="py-line"><tt class="py-string">bibliography_from_id() or entry_from_id().</tt> </tt>
<a name="L99"></a><tt class="py-lineno">  99</tt>  <tt class="py-line"><tt class="py-string"></tt> </tt>
<a name="L100"></a><tt class="py-lineno"> 100</tt>  <tt class="py-line"><tt class="py-string">@type: C{dict}</tt> </tt>
<a name="L101"></a><tt class="py-lineno"> 101</tt>  <tt class="py-line"><tt class="py-string">@deprecated:</tt> </tt>
<a name="L102"></a><tt class="py-lineno"> 102</tt>  <tt class="py-line"><tt class="py-string">    This caching method will be dropped in future revisions.</tt> </tt>
<a name="L103"></a><tt class="py-lineno"> 103</tt>  <tt class="py-line"><tt class="py-string">'''</tt> </tt>
<a name="bibliography_from_id"></a><div id="bibliography_from_id-def"><a name="L104"></a><tt class="py-lineno"> 104</tt>  <tt class="py-line"> </tt>
<a name="L105"></a><tt class="py-lineno"> 105</tt>  <tt class="py-line"> </tt>
<a name="L106"></a><tt class="py-lineno"> 106</tt>  <tt class="py-line"><tt class="py-comment"># Module level functions</tt> </tt>
<a name="L107"></a><tt class="py-lineno"> 107</tt>  <tt class="py-line"> </tt>
<a name="L108"></a><tt class="py-lineno"> 108</tt> <a class="py-toggle" href="#" id="bibliography_from_id-toggle" onclick="return toggle('bibliography_from_id');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography-module.html#bibliography_from_id">bibliography_from_id</a><tt class="py-op">(</tt><tt class="py-param">dataset_id</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="bibliography_from_id-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="bibliography_from_id-expanded"><a name="L109"></a><tt class="py-lineno"> 109</tt>  <tt class="py-line">    <tt class="py-docstring">'''Returns a bibliography based on its id.</tt> </tt>
<a name="L110"></a><tt class="py-lineno"> 110</tt>  <tt class="py-line"><tt class="py-docstring">    @rtype: L{Bibliography}</tt> </tt>
<a name="L111"></a><tt class="py-lineno"> 111</tt>  <tt class="py-line"><tt class="py-docstring">    @todo: consider revising or replacing the caching system used here.</tt> </tt>
<a name="L112"></a><tt class="py-lineno"> 112</tt>  <tt class="py-line"><tt class="py-docstring">    @todo: add error handling</tt> </tt>
<a name="L113"></a><tt class="py-lineno"> 113</tt>  <tt class="py-line"><tt class="py-docstring">    '''</tt> </tt>
<a name="L114"></a><tt class="py-lineno"> 114</tt>  <tt class="py-line">    <tt id="link-50" class="py-name"><a title="bkn.bibtex.utilities.ensure_objects_are_unicode" class="py-name" href="#" onclick="return doclink('link-50', 'ensure_objects_are_unicode', 'link-8');">ensure_objects_are_unicode</a></tt><tt class="py-op">(</tt><tt class="py-name">dataset_id</tt><tt class="py-op">)</tt> </tt>
<a name="L115"></a><tt class="py-lineno"> 115</tt>  <tt class="py-line">    <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L116"></a><tt class="py-lineno"> 116</tt>  <tt class="py-line">        <tt class="py-name">bib</tt> <tt class="py-op">=</tt> <tt id="link-51" class="py-name"><a title="bkn.bibtex.bibliography.bib_cache" class="py-name" href="#" onclick="return doclink('link-51', 'bib_cache', 'link-49');">bib_cache</a></tt><tt class="py-op">[</tt><tt class="py-name">dataset_id</tt><tt class="py-op">]</tt> </tt>
<a name="L117"></a><tt class="py-lineno"> 117</tt>  <tt class="py-line">    <tt class="py-keyword">except</tt> <tt class="py-name">KeyError</tt><tt class="py-op">:</tt> </tt>
<a name="L118"></a><tt class="py-lineno"> 118</tt>  <tt class="py-line">        <tt class="py-name">bib</tt> <tt class="py-op">=</tt> <tt id="link-52" class="py-name"><a title="bkn.bibtex.bibliography.bib_cache" class="py-name" href="#" onclick="return doclink('link-52', 'bib_cache', 'link-49');">bib_cache</a></tt><tt class="py-op">[</tt><tt class="py-name">dataset_id</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt id="link-53" class="py-name" targets="Class bkn.bibtex.bibliography.Bibliography=bkn.bibtex.bibliography.Bibliography-class.html"><a title="bkn.bibtex.bibliography.Bibliography" class="py-name" href="#" onclick="return doclink('link-53', 'Bibliography', 'link-53');">Bibliography</a></tt><tt class="py-op">(</tt><tt class="py-name">file</tt><tt class="py-op">=</tt><tt class="py-name">dataset_id</tt><tt class="py-op">)</tt> </tt>
<a name="L119"></a><tt class="py-lineno"> 119</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">bib</tt> </tt>
</div><a name="L120"></a><tt class="py-lineno"> 120</tt>  <tt class="py-line">      </tt>
<a name="record_from_id"></a><div id="record_from_id-def"><a name="L121"></a><tt class="py-lineno"> 121</tt> <a class="py-toggle" href="#" id="record_from_id-toggle" onclick="return toggle('record_from_id');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography-module.html#record_from_id">record_from_id</a><tt class="py-op">(</tt><tt class="py-param">global_id</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="record_from_id-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="record_from_id-expanded"><a name="L122"></a><tt class="py-lineno"> 122</tt>  <tt class="py-line">    <tt class="py-docstring">'''Returns a bibliography entry given the global id of the record.</tt> </tt>
<a name="L123"></a><tt class="py-lineno"> 123</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L124"></a><tt class="py-lineno"> 124</tt>  <tt class="py-line"><tt class="py-docstring">    Unlike the L{resolve_reference()&lt;Bibliography.resolve_reference&gt;} method, this is a module level</tt> </tt>
<a name="L125"></a><tt class="py-lineno"> 125</tt>  <tt class="py-line"><tt class="py-docstring">    function and does not require a C{Bibliography} instance. As a</tt> </tt>
<a name="L126"></a><tt class="py-lineno"> 126</tt>  <tt class="py-line"><tt class="py-docstring">    consequence it can only resolve global ids.</tt> </tt>
<a name="L127"></a><tt class="py-lineno"> 127</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L128"></a><tt class="py-lineno"> 128</tt>  <tt class="py-line"><tt class="py-docstring">    @param global_id:</tt> </tt>
<a name="L129"></a><tt class="py-lineno"> 129</tt>  <tt class="py-line"><tt class="py-docstring">        the global id of a record. This should be just the records id</tt> </tt>
<a name="L130"></a><tt class="py-lineno"> 130</tt>  <tt class="py-line"><tt class="py-docstring">        and should not include the "@@" that precedes a global id in</tt> </tt>
<a name="L131"></a><tt class="py-lineno"> 131</tt>  <tt class="py-line"><tt class="py-docstring">        BibJSON references.</tt> </tt>
<a name="L132"></a><tt class="py-lineno"> 132</tt>  <tt class="py-line"><tt class="py-docstring">    @rtype: L{Record}</tt> </tt>
<a name="L133"></a><tt class="py-lineno"> 133</tt>  <tt class="py-line"><tt class="py-docstring">    @todo: document return values and exceptions</tt> </tt>
<a name="L134"></a><tt class="py-lineno"> 134</tt>  <tt class="py-line"><tt class="py-docstring">    @todo: use appropriate error classes</tt> </tt>
<a name="L135"></a><tt class="py-lineno"> 135</tt>  <tt class="py-line"><tt class="py-docstring">    @warning:</tt> </tt>
<a name="L136"></a><tt class="py-lineno"> 136</tt>  <tt class="py-line"><tt class="py-docstring">         Do not confuse this module level method with the</tt> </tt>
<a name="L137"></a><tt class="py-lineno"> 137</tt>  <tt class="py-line"><tt class="py-docstring">         L{record_from_id()&lt;Bibliography.record_from_id&gt;} method in the L{Bibliography} class.</tt> </tt>
<a name="L138"></a><tt class="py-lineno"> 138</tt>  <tt class="py-line"><tt class="py-docstring">    '''</tt> </tt>
<a name="L139"></a><tt class="py-lineno"> 139</tt>  <tt class="py-line">    <tt id="link-54" class="py-name"><a title="bkn.bibtex.utilities.ensure_objects_are_unicode" class="py-name" href="#" onclick="return doclink('link-54', 'ensure_objects_are_unicode', 'link-8');">ensure_objects_are_unicode</a></tt><tt class="py-op">(</tt><tt id="link-55" class="py-name" targets="Method bkn.bibtex.bibliography.Record.global_id()=bkn.bibtex.bibliography.Record-class.html#global_id"><a title="bkn.bibtex.bibliography.Record.global_id" class="py-name" href="#" onclick="return doclink('link-55', 'global_id', 'link-55');">global_id</a></tt><tt class="py-op">)</tt> </tt>
<a name="L140"></a><tt class="py-lineno"> 140</tt>  <tt class="py-line">    <tt class="py-name">parse_result</tt> <tt class="py-op">=</tt> <tt class="py-name">urlparse</tt><tt class="py-op">.</tt><tt class="py-name">urlparse</tt><tt class="py-op">(</tt><tt id="link-56" class="py-name"><a title="bkn.bibtex.bibliography.Record.global_id" class="py-name" href="#" onclick="return doclink('link-56', 'global_id', 'link-55');">global_id</a></tt><tt class="py-op">)</tt> </tt>
<a name="L141"></a><tt class="py-lineno"> 141</tt>  <tt class="py-line">    <tt class="py-keyword">if</tt> <tt class="py-name">parse_result</tt><tt class="py-op">.</tt><tt class="py-name">scheme</tt> <tt class="py-op">==</tt> <tt class="py-string">''</tt><tt class="py-op">:</tt> </tt>
<a name="L142"></a><tt class="py-lineno"> 142</tt>  <tt class="py-line">        <tt class="py-keyword">raise</tt> <tt id="link-57" class="py-name"><a title="bkn.bibtex.error.InvalidReferenceError" class="py-name" href="#" onclick="return doclink('link-57', 'InvalidReferenceError', 'link-35');">InvalidReferenceError</a></tt><tt class="py-op">(</tt> </tt>
<a name="L143"></a><tt class="py-lineno"> 143</tt>  <tt class="py-line">            <tt class="py-string">'"'</tt> <tt class="py-op">+</tt> <tt id="link-58" class="py-name"><a title="bkn.bibtex.bibliography.Record.global_id" class="py-name" href="#" onclick="return doclink('link-58', 'global_id', 'link-55');">global_id</a></tt> <tt class="py-op">+</tt> <tt class="py-string">'" is not a valid reference. '</tt> <tt class="py-op">+</tt> </tt>
<a name="L144"></a><tt class="py-lineno"> 144</tt>  <tt class="py-line">            <tt class="py-string">'Valid global references must be URIs.'</tt><tt class="py-op">)</tt> </tt>
<a name="L145"></a><tt class="py-lineno"> 145</tt>  <tt class="py-line">    <tt class="py-name">uri_without_fragment</tt><tt class="py-op">,</tt> <tt class="py-name">fragment</tt> <tt class="py-op">=</tt> <tt class="py-name">urlparse</tt><tt class="py-op">.</tt><tt class="py-name">urldefrag</tt><tt class="py-op">(</tt><tt id="link-59" class="py-name"><a title="bkn.bibtex.bibliography.Record.global_id" class="py-name" href="#" onclick="return doclink('link-59', 'global_id', 'link-55');">global_id</a></tt><tt class="py-op">)</tt> </tt>
<a name="L146"></a><tt class="py-lineno"> 146</tt>  <tt class="py-line">    <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L147"></a><tt class="py-lineno"> 147</tt>  <tt class="py-line">        <tt class="py-name">response</tt> <tt class="py-op">=</tt> <tt class="py-name">urllib</tt><tt class="py-op">.</tt><tt class="py-name">urlopen</tt><tt class="py-op">(</tt><tt class="py-name">uri_without_fragment</tt><tt class="py-op">)</tt> </tt>
<a name="L148"></a><tt class="py-lineno"> 148</tt>  <tt class="py-line">    <tt class="py-keyword">except</tt> <tt class="py-name">IOError</tt> <tt class="py-keyword">as</tt> <tt class="py-name">ioerror</tt><tt class="py-op">:</tt> </tt>
<a name="L149"></a><tt class="py-lineno"> 149</tt>  <tt class="py-line">        <tt class="py-comment"># reference was valid but could not be resolved</tt> </tt>
<a name="L150"></a><tt class="py-lineno"> 150</tt>  <tt class="py-line">        <tt class="py-keyword">raise</tt> <tt id="link-60" class="py-name"><a title="bkn.bibtex.error.RecordNotFoundError" class="py-name" href="#" onclick="return doclink('link-60', 'RecordNotFoundError', 'link-41');">RecordNotFoundError</a></tt><tt class="py-op">(</tt> </tt>
<a name="L151"></a><tt class="py-lineno"> 151</tt>  <tt class="py-line">            <tt class="py-string">'"'</tt> <tt class="py-op">+</tt> <tt id="link-61" class="py-name"><a title="bkn.bibtex.bibliography.Record.global_id" class="py-name" href="#" onclick="return doclink('link-61', 'global_id', 'link-55');">global_id</a></tt> <tt class="py-op">+</tt> <tt class="py-string">'" appears to be a valid reference but could '</tt> <tt class="py-op">+</tt> </tt>
<a name="L152"></a><tt class="py-lineno"> 152</tt>  <tt class="py-line">            <tt class="py-string">'not be resolved. This could be a problem with your network or '</tt> <tt class="py-op">+</tt> </tt>
<a name="L153"></a><tt class="py-lineno"> 153</tt>  <tt class="py-line">            <tt class="py-string">'the service meant to be hosting this resource. (IOError:'</tt> <tt class="py-op">+</tt> </tt>
<a name="L154"></a><tt class="py-lineno"> 154</tt>  <tt class="py-line">            <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">ioerror</tt><tt class="py-op">)</tt> <tt class="py-op">+</tt> <tt class="py-string">')'</tt><tt class="py-op">)</tt> </tt>
<a name="L155"></a><tt class="py-lineno"> 155</tt>  <tt class="py-line">    <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L156"></a><tt class="py-lineno"> 156</tt>  <tt class="py-line">        <tt class="py-name">py_object</tt> <tt class="py-op">=</tt> <tt class="py-name">json</tt><tt class="py-op">.</tt><tt class="py-name">load</tt><tt class="py-op">(</tt><tt class="py-name">response</tt><tt class="py-op">)</tt> </tt>
<a name="L157"></a><tt class="py-lineno"> 157</tt>  <tt class="py-line">    <tt class="py-keyword">except</tt><tt class="py-op">:</tt> </tt>
<a name="L158"></a><tt class="py-lineno"> 158</tt>  <tt class="py-line">        <tt class="py-keyword">raise</tt> <tt class="py-name">Exception</tt><tt class="py-op">(</tt><tt class="py-string">'The document retrieved from '</tt> <tt class="py-op">+</tt> <tt class="py-name">uri_without_fragment</tt> <tt class="py-op">+</tt> </tt>
<a name="L159"></a><tt class="py-lineno"> 159</tt>  <tt class="py-line">            <tt class="py-string">' could not be parsed as JSON.'</tt><tt class="py-op">)</tt> </tt>
<a name="L160"></a><tt class="py-lineno"> 160</tt>  <tt class="py-line">    <tt class="py-keyword">if</tt> <tt class="py-name">py_object</tt><tt class="py-op">.</tt><tt class="py-name">has_key</tt><tt class="py-op">(</tt><tt class="py-string">u'id'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L161"></a><tt class="py-lineno"> 161</tt>  <tt class="py-line">        <tt class="py-comment"># an individual record was returned</tt> </tt>
<a name="L162"></a><tt class="py-lineno"> 162</tt>  <tt class="py-line">        <tt class="py-name">result</tt> <tt class="py-op">=</tt> <tt id="link-62" class="py-name" targets="Class bkn.bibtex.bibliography.Record=bkn.bibtex.bibliography.Record-class.html"><a title="bkn.bibtex.bibliography.Record" class="py-name" href="#" onclick="return doclink('link-62', 'Record', 'link-62');">Record</a></tt><tt class="py-op">(</tt><tt class="py-name">attribute_map</tt><tt class="py-op">=</tt><tt class="py-name">py_object</tt><tt class="py-op">)</tt> </tt>
<a name="L163"></a><tt class="py-lineno"> 163</tt>  <tt class="py-line">        <tt class="py-comment"># we should set parent_bib_id here if we can</tt> </tt>
<a name="L164"></a><tt class="py-lineno"> 164</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">result</tt> </tt>
<a name="L165"></a><tt class="py-lineno"> 165</tt>  <tt class="py-line">    <tt class="py-keyword">elif</tt> <tt class="py-name">py_object</tt><tt class="py-op">.</tt><tt class="py-name">has_key</tt><tt class="py-op">(</tt><tt class="py-string">'recordList'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L166"></a><tt class="py-lineno"> 166</tt>  <tt class="py-line">        <tt class="py-comment"># get dataset id</tt> </tt>
<a name="L167"></a><tt class="py-lineno"> 167</tt>  <tt class="py-line">        <tt class="py-name">dataset_id</tt> <tt class="py-op">=</tt> <tt class="py-name">py_object</tt><tt class="py-op">[</tt><tt class="py-string">u'dataset'</tt><tt class="py-op">]</tt><tt class="py-op">[</tt><tt class="py-string">u'id'</tt><tt class="py-op">]</tt> </tt>
<a name="L168"></a><tt class="py-lineno"> 168</tt>  <tt class="py-line">        <tt class="py-keyword">for</tt> <tt class="py-name">record</tt> <tt class="py-keyword">in</tt> <tt class="py-name">py_object</tt><tt class="py-op">[</tt><tt class="py-string">u'recordList'</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
<a name="L169"></a><tt class="py-lineno"> 169</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">dataset_id</tt> <tt class="py-op">+</tt> <tt class="py-name">record</tt><tt class="py-op">[</tt><tt class="py-string">u'id'</tt><tt class="py-op">]</tt> <tt class="py-op">==</tt> <tt id="link-63" class="py-name"><a title="bkn.bibtex.bibliography.Record.global_id" class="py-name" href="#" onclick="return doclink('link-63', 'global_id', 'link-55');">global_id</a></tt><tt class="py-op">:</tt> </tt>
<a name="L170"></a><tt class="py-lineno"> 170</tt>  <tt class="py-line">                <tt class="py-name">result</tt> <tt class="py-op">=</tt> <tt id="link-64" class="py-name"><a title="bkn.bibtex.bibliography.Record" class="py-name" href="#" onclick="return doclink('link-64', 'Record', 'link-62');">Record</a></tt><tt class="py-op">(</tt><tt class="py-name">attribute_map</tt><tt class="py-op">=</tt><tt class="py-name">record</tt><tt class="py-op">)</tt> </tt>
<a name="L171"></a><tt class="py-lineno"> 171</tt>  <tt class="py-line">                <tt class="py-name">result</tt><tt class="py-op">.</tt><tt class="py-name">parent_bib_id</tt> <tt class="py-op">=</tt> <tt class="py-name">dataset_id</tt> </tt>
<a name="L172"></a><tt class="py-lineno"> 172</tt>  <tt class="py-line">                <tt class="py-keyword">return</tt> <tt class="py-name">result</tt> </tt>
<a name="L173"></a><tt class="py-lineno"> 173</tt>  <tt class="py-line">        <tt class="py-keyword">raise</tt> <tt id="link-65" class="py-name"><a title="bkn.bibtex.error.RecordNotFoundError" class="py-name" href="#" onclick="return doclink('link-65', 'RecordNotFoundError', 'link-41');">RecordNotFoundError</a></tt><tt class="py-op">(</tt> </tt>
<a name="L174"></a><tt class="py-lineno"> 174</tt>  <tt class="py-line">            <tt class="py-string">'No record with id "'</tt> <tt class="py-op">+</tt> <tt id="link-66" class="py-name"><a title="bkn.bibtex.bibliography.Record.global_id" class="py-name" href="#" onclick="return doclink('link-66', 'global_id', 'link-55');">global_id</a></tt> <tt class="py-op">+</tt> <tt class="py-string">'" was found in the '</tt> <tt class="py-op">+</tt> </tt>
<a name="L175"></a><tt class="py-lineno"> 175</tt>  <tt class="py-line">            <tt class="py-string">'record list retrieved from '</tt> <tt class="py-op">+</tt> <tt class="py-name">uri_without_fragment</tt> <tt class="py-op">+</tt> <tt class="py-string">'.'</tt><tt class="py-op">)</tt> </tt>
<a name="L176"></a><tt class="py-lineno"> 176</tt>  <tt class="py-line">    <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L177"></a><tt class="py-lineno"> 177</tt>  <tt class="py-line">        <tt class="py-keyword">raise</tt> <tt id="link-67" class="py-name"><a title="bkn.bibtex.error.InvalidResponseError" class="py-name" href="#" onclick="return doclink('link-67', 'InvalidResponseError', 'link-38');">InvalidResponseError</a></tt><tt class="py-op">(</tt> </tt>
<a name="L178"></a><tt class="py-lineno"> 178</tt>  <tt class="py-line">            <tt class="py-string">'Invalid response. The retrieved resource does not appear to '</tt> <tt class="py-op">+</tt> </tt>
<a name="L179"></a><tt class="py-lineno"> 179</tt>  <tt class="py-line">            <tt class="py-string">'be valid BibJSON.'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L180"></a><tt class="py-lineno"> 180</tt>  <tt class="py-line"> </tt>
<a name="entry_from_id"></a><div id="entry_from_id-def"><a name="L181"></a><tt class="py-lineno"> 181</tt> <a class="py-toggle" href="#" id="entry_from_id-toggle" onclick="return toggle('entry_from_id');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography-module.html#entry_from_id">entry_from_id</a><tt class="py-op">(</tt><tt class="py-param">dataset_id</tt><tt class="py-op">,</tt> <tt class="py-param">record_id</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="entry_from_id-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="entry_from_id-expanded"><a name="L182"></a><tt class="py-lineno"> 182</tt>  <tt class="py-line">    <tt class="py-docstring">'''</tt> </tt>
<a name="L183"></a><tt class="py-lineno"> 183</tt>  <tt class="py-line"><tt class="py-docstring">    @deprecated:</tt> </tt>
<a name="L184"></a><tt class="py-lineno"> 184</tt>  <tt class="py-line"><tt class="py-docstring">        use L{record_from_id()} instead.</tt> </tt>
<a name="L185"></a><tt class="py-lineno"> 185</tt>  <tt class="py-line"><tt class="py-docstring">    @rtype: L{Record}</tt> </tt>
<a name="L186"></a><tt class="py-lineno"> 186</tt>  <tt class="py-line"><tt class="py-docstring">    '''</tt> </tt>
<a name="L187"></a><tt class="py-lineno"> 187</tt>  <tt class="py-line">    <tt id="link-68" class="py-name"><a title="bkn.bibtex.utilities.ensure_objects_are_unicode" class="py-name" href="#" onclick="return doclink('link-68', 'ensure_objects_are_unicode', 'link-8');">ensure_objects_are_unicode</a></tt><tt class="py-op">(</tt><tt class="py-name">dataset_id</tt><tt class="py-op">,</tt> <tt class="py-name">record_id</tt><tt class="py-op">)</tt> </tt>
<a name="L188"></a><tt class="py-lineno"> 188</tt>  <tt class="py-line">    <tt class="py-name">warnings</tt><tt class="py-op">.</tt><tt class="py-name">warn</tt><tt class="py-op">(</tt> </tt>
<a name="L189"></a><tt class="py-lineno"> 189</tt>  <tt class="py-line">        <tt class="py-string">"The entry_from_id() method has been deprecated. Use record_from_id() instead."</tt><tt class="py-op">,</tt>  </tt>
<a name="L190"></a><tt class="py-lineno"> 190</tt>  <tt class="py-line">        <tt class="py-name">DeprecationWarning</tt><tt class="py-op">,</tt> <tt class="py-name">stacklevel</tt><tt class="py-op">=</tt><tt class="py-number">2</tt><tt class="py-op">)</tt> </tt>
<a name="L191"></a><tt class="py-lineno"> 191</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt id="link-69" class="py-name" targets="Method bkn.bibtex.bibliography.Bibliography.record_from_id()=bkn.bibtex.bibliography.Bibliography-class.html#record_from_id,Function bkn.bibtex.bibliography.record_from_id()=bkn.bibtex.bibliography-module.html#record_from_id"><a title="bkn.bibtex.bibliography.Bibliography.record_from_id
bkn.bibtex.bibliography.record_from_id" class="py-name" href="#" onclick="return doclink('link-69', 'record_from_id', 'link-69');">record_from_id</a></tt><tt class="py-op">(</tt><tt class="py-name">dataset_id</tt> <tt class="py-op">+</tt> <tt class="py-name">record_id</tt><tt class="py-op">)</tt> </tt>
</div><a name="L192"></a><tt class="py-lineno"> 192</tt>  <tt class="py-line"> </tt>
<a name="_sort_with_standard_fields_first"></a><div id="_sort_with_standard_fields_first-def"><a name="L193"></a><tt class="py-lineno"> 193</tt> <a class="py-toggle" href="#" id="_sort_with_standard_fields_first-toggle" onclick="return toggle('_sort_with_standard_fields_first');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography-module.html#_sort_with_standard_fields_first">_sort_with_standard_fields_first</a><tt class="py-op">(</tt><tt class="py-param">attribute_names</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_sort_with_standard_fields_first-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_sort_with_standard_fields_first-expanded"><a name="L194"></a><tt class="py-lineno"> 194</tt>  <tt class="py-line">    <tt class="py-docstring">'''Sorts a list of attribute names so that standard BibTeX fields</tt> </tt>
<a name="L195"></a><tt class="py-lineno"> 195</tt>  <tt class="py-line"><tt class="py-docstring">    are listed first and nonstandard fields are listed second. Within</tt> </tt>
<a name="L196"></a><tt class="py-lineno"> 196</tt>  <tt class="py-line"><tt class="py-docstring">    each category fields will be listed alphabetically.</tt> </tt>
<a name="L197"></a><tt class="py-lineno"> 197</tt>  <tt class="py-line"><tt class="py-docstring">    '''</tt> </tt>
<a name="L198"></a><tt class="py-lineno"> 198</tt>  <tt class="py-line">    <tt id="link-70" class="py-name"><a title="bkn.bibtex.utilities.ensure_objects_are_unicode" class="py-name" href="#" onclick="return doclink('link-70', 'ensure_objects_are_unicode', 'link-8');">ensure_objects_are_unicode</a></tt><tt class="py-op">(</tt><tt class="py-op">*</tt><tt id="link-71" class="py-name" targets="Method bkn.bibtex.bibliography.Record.attribute_names()=bkn.bibtex.bibliography.Record-class.html#attribute_names"><a title="bkn.bibtex.bibliography.Record.attribute_names" class="py-name" href="#" onclick="return doclink('link-71', 'attribute_names', 'link-71');">attribute_names</a></tt><tt class="py-op">)</tt> </tt>
<a name="L199"></a><tt class="py-lineno"> 199</tt>  <tt class="py-line">    <tt class="py-name">nonstandard_attributes</tt> <tt class="py-op">=</tt> <tt class="py-name">list</tt><tt class="py-op">(</tt><tt class="py-name">set</tt><tt class="py-op">(</tt><tt id="link-72" class="py-name"><a title="bkn.bibtex.bibliography.Record.attribute_names" class="py-name" href="#" onclick="return doclink('link-72', 'attribute_names', 'link-71');">attribute_names</a></tt><tt class="py-op">)</tt> <tt class="py-op">-</tt> <tt class="py-name">set</tt><tt class="py-op">(</tt><tt id="link-73" class="py-name"><a title="bkn.bibtex.bibliography.BIBTEX_FIELDS" class="py-name" href="#" onclick="return doclink('link-73', 'BIBTEX_FIELDS', 'link-45');">BIBTEX_FIELDS</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L200"></a><tt class="py-lineno"> 200</tt>  <tt class="py-line">    <tt class="py-name">standard_attributes</tt> <tt class="py-op">=</tt> <tt class="py-name">list</tt><tt class="py-op">(</tt><tt class="py-name">set</tt><tt class="py-op">(</tt><tt id="link-74" class="py-name"><a title="bkn.bibtex.bibliography.Record.attribute_names" class="py-name" href="#" onclick="return doclink('link-74', 'attribute_names', 'link-71');">attribute_names</a></tt><tt class="py-op">)</tt> <tt class="py-op">-</tt> <tt class="py-name">set</tt><tt class="py-op">(</tt><tt class="py-name">nonstandard_attributes</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L201"></a><tt class="py-lineno"> 201</tt>  <tt class="py-line">    <tt class="py-name">nonstandard_attributes</tt><tt class="py-op">.</tt><tt id="link-75" class="py-name" targets="Method bkn.bibtex.bibliography.Bibliography.sort()=bkn.bibtex.bibliography.Bibliography-class.html#sort"><a title="bkn.bibtex.bibliography.Bibliography.sort" class="py-name" href="#" onclick="return doclink('link-75', 'sort', 'link-75');">sort</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L202"></a><tt class="py-lineno"> 202</tt>  <tt class="py-line">    <tt class="py-name">standard_attributes</tt><tt class="py-op">.</tt><tt id="link-76" class="py-name"><a title="bkn.bibtex.bibliography.Bibliography.sort" class="py-name" href="#" onclick="return doclink('link-76', 'sort', 'link-75');">sort</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L203"></a><tt class="py-lineno"> 203</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">standard_attributes</tt> <tt class="py-op">+</tt> <tt class="py-name">nonstandard_attributes</tt> </tt>
</div><a name="L204"></a><tt class="py-lineno"> 204</tt>  <tt class="py-line"> </tt>
<a name="Record"></a><div id="Record-def"><a name="L205"></a><tt class="py-lineno"> 205</tt>  <tt class="py-line"> </tt>
<a name="L206"></a><tt class="py-lineno"> 206</tt>  <tt class="py-line"><tt class="py-comment"># Class definitions</tt> </tt>
<a name="L207"></a><tt class="py-lineno"> 207</tt>  <tt class="py-line"> </tt>
<a name="L208"></a><tt class="py-lineno"> 208</tt> <a class="py-toggle" href="#" id="Record-toggle" onclick="return toggle('Record');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="bkn.bibtex.bibliography.Record-class.html">Record</a><tt class="py-op">:</tt> </tt>
</div><div id="Record-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="Record-expanded"><a name="L209"></a><tt class="py-lineno"> 209</tt>  <tt class="py-line">    <tt class="py-docstring">'''A single record in the dataset, usually a bibliography entry.</tt> </tt>
<a name="L210"></a><tt class="py-lineno"> 210</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L211"></a><tt class="py-lineno"> 211</tt>  <tt class="py-line"><tt class="py-docstring">    The preferred method to access to a Record's attributes is to use bracket</tt> </tt>
<a name="L212"></a><tt class="py-lineno"> 212</tt>  <tt class="py-line"><tt class="py-docstring">    notation, just as the built in dictionary type does, so you can do:</tt> </tt>
<a name="L213"></a><tt class="py-lineno"> 213</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L214"></a><tt class="py-lineno"> 214</tt>  <tt class="py-line"><tt class="py-docstring">        &gt;&gt;&gt; e = Record(u'key', bibtype=u'article')</tt> </tt>
<a name="L215"></a><tt class="py-lineno"> 215</tt>  <tt class="py-line"><tt class="py-docstring">        &gt;&gt;&gt; e[u'title'] = 'Of Mice and Men'</tt> </tt>
<a name="L216"></a><tt class="py-lineno"> 216</tt>  <tt class="py-line"><tt class="py-docstring">        &gt;&gt;&gt; e[u'title']</tt> </tt>
<a name="L217"></a><tt class="py-lineno"> 217</tt>  <tt class="py-line"><tt class="py-docstring">        'Of Mice and Men'</tt> </tt>
<a name="L218"></a><tt class="py-lineno"> 218</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L219"></a><tt class="py-lineno"> 219</tt>  <tt class="py-line"><tt class="py-docstring">    An empty string will be returned if you try to access an undefined</tt> </tt>
<a name="L220"></a><tt class="py-lineno"> 220</tt>  <tt class="py-line"><tt class="py-docstring">    attribute. Attribute names accessed and set this way are case insensitive.</tt> </tt>
<a name="L221"></a><tt class="py-lineno"> 221</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L222"></a><tt class="py-lineno"> 222</tt>  <tt class="py-line"><tt class="py-docstring">    @warning:</tt> </tt>
<a name="L223"></a><tt class="py-lineno"> 223</tt>  <tt class="py-line"><tt class="py-docstring">       While the Record class does handle attribute access using the</tt> </tt>
<a name="L224"></a><tt class="py-lineno"> 224</tt>  <tt class="py-line"><tt class="py-docstring">       bracket notation it is not a mapping object. If you need to use</tt> </tt>
<a name="L225"></a><tt class="py-lineno"> 225</tt>  <tt class="py-line"><tt class="py-docstring">       mapping object methods you can access a Records's attribute</tt> </tt>
<a name="L226"></a><tt class="py-lineno"> 226</tt>  <tt class="py-line"><tt class="py-docstring">       dictionary directly:</tt> </tt>
<a name="L227"></a><tt class="py-lineno"> 227</tt>  <tt class="py-line"><tt class="py-docstring">           </tt> </tt>
<a name="L228"></a><tt class="py-lineno"> 228</tt>  <tt class="py-line"><tt class="py-docstring">           &gt;&gt;&gt; field_names = record.attribute_map.keys()</tt> </tt>
<a name="L229"></a><tt class="py-lineno"> 229</tt>  <tt class="py-line"><tt class="py-docstring">       </tt> </tt>
<a name="L230"></a><tt class="py-lineno"> 230</tt>  <tt class="py-line"><tt class="py-docstring">       It is, however, important that any new keys added to the</tt> </tt>
<a name="L231"></a><tt class="py-lineno"> 231</tt>  <tt class="py-line"><tt class="py-docstring">       dictionary in this way be lowercase, as the following example</tt> </tt>
<a name="L232"></a><tt class="py-lineno"> 232</tt>  <tt class="py-line"><tt class="py-docstring">       illustrates:</tt> </tt>
<a name="L233"></a><tt class="py-lineno"> 233</tt>  <tt class="py-line"><tt class="py-docstring">       </tt> </tt>
<a name="L234"></a><tt class="py-lineno"> 234</tt>  <tt class="py-line"><tt class="py-docstring">           &gt;&gt;&gt; record[u'TITLE'] = 'Spam'</tt> </tt>
<a name="L235"></a><tt class="py-lineno"> 235</tt>  <tt class="py-line"><tt class="py-docstring">           &gt;&gt;&gt; record.fields[u'TITLE'] = 'Eggs'</tt> </tt>
<a name="L236"></a><tt class="py-lineno"> 236</tt>  <tt class="py-line"><tt class="py-docstring">           &gt;&gt;&gt; record[u'TITLE']</tt> </tt>
<a name="L237"></a><tt class="py-lineno"> 237</tt>  <tt class="py-line"><tt class="py-docstring">           'Spam'      # not eggs!</tt> </tt>
<a name="L238"></a><tt class="py-lineno"> 238</tt>  <tt class="py-line"><tt class="py-docstring">    '''</tt> </tt>
<a name="Record.__init__"></a><div id="Record.__init__-def"><a name="L239"></a><tt class="py-lineno"> 239</tt> <a class="py-toggle" href="#" id="Record.__init__-toggle" onclick="return toggle('Record.__init__');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography.Record-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">citekey</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">bibtype</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">attribute_map</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Record.__init__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Record.__init__-expanded"><a name="L240"></a><tt class="py-lineno"> 240</tt>  <tt class="py-line">        <tt class="py-docstring">'''Initializes a new Record instance.</tt> </tt>
<a name="L241"></a><tt class="py-lineno"> 241</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L242"></a><tt class="py-lineno"> 242</tt>  <tt class="py-line"><tt class="py-docstring">        @param citekey: the local id for this record.</tt> </tt>
<a name="L243"></a><tt class="py-lineno"> 243</tt>  <tt class="py-line"><tt class="py-docstring">        @type citekey: str</tt> </tt>
<a name="L244"></a><tt class="py-lineno"> 244</tt>  <tt class="py-line"><tt class="py-docstring">        @param bibtype: the type attribute for this record.</tt> </tt>
<a name="L245"></a><tt class="py-lineno"> 245</tt>  <tt class="py-line"><tt class="py-docstring">        @type bibtype: str</tt> </tt>
<a name="L246"></a><tt class="py-lineno"> 246</tt>  <tt class="py-line"><tt class="py-docstring">        @param attribute_map:</tt> </tt>
<a name="L247"></a><tt class="py-lineno"> 247</tt>  <tt class="py-line"><tt class="py-docstring">             attribute name-value pairs with which to initialize this</tt> </tt>
<a name="L248"></a><tt class="py-lineno"> 248</tt>  <tt class="py-line"><tt class="py-docstring">             Record.</tt> </tt>
<a name="L249"></a><tt class="py-lineno"> 249</tt>  <tt class="py-line"><tt class="py-docstring">        @type attribute_map: dict</tt> </tt>
<a name="L250"></a><tt class="py-lineno"> 250</tt>  <tt class="py-line"><tt class="py-docstring">        @raise BKNBibtexError: if an id for the record has not been specified. </tt> </tt>
<a name="L251"></a><tt class="py-lineno"> 251</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L252"></a><tt class="py-lineno"> 252</tt>  <tt class="py-line"><tt class="py-docstring">        @todo:</tt> </tt>
<a name="L253"></a><tt class="py-lineno"> 253</tt>  <tt class="py-line"><tt class="py-docstring">            deprecate 'citekey' and 'bibtype' keyword arguments in</tt> </tt>
<a name="L254"></a><tt class="py-lineno"> 254</tt>  <tt class="py-line"><tt class="py-docstring">            favor of 'id' and 'type'</tt> </tt>
<a name="L255"></a><tt class="py-lineno"> 255</tt>  <tt class="py-line"><tt class="py-docstring">        @todo: consider subclassing BKNBibtexError</tt> </tt>
<a name="L256"></a><tt class="py-lineno"> 256</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L257"></a><tt class="py-lineno"> 257</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">attribute_map</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L258"></a><tt class="py-lineno"> 258</tt>  <tt class="py-line">            <tt id="link-77" class="py-name"><a title="bkn.bibtex.utilities.ensure_objects_are_unicode" class="py-name" href="#" onclick="return doclink('link-77', 'ensure_objects_are_unicode', 'link-8');">ensure_objects_are_unicode</a></tt><tt class="py-op">(</tt><tt class="py-name">citekey</tt><tt class="py-op">,</tt> <tt class="py-name">bibtype</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">attribute_map</tt><tt class="py-op">)</tt> </tt>
<a name="L259"></a><tt class="py-lineno"> 259</tt>  <tt class="py-line">        <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L260"></a><tt class="py-lineno"> 260</tt>  <tt class="py-line">            <tt id="link-78" class="py-name"><a title="bkn.bibtex.utilities.ensure_objects_are_unicode" class="py-name" href="#" onclick="return doclink('link-78', 'ensure_objects_are_unicode', 'link-8');">ensure_objects_are_unicode</a></tt><tt class="py-op">(</tt><tt class="py-name">citekey</tt><tt class="py-op">,</tt> <tt class="py-name">bibtype</tt><tt class="py-op">)</tt> </tt>
<a name="L261"></a><tt class="py-lineno"> 261</tt>  <tt class="py-line">         </tt>
<a name="L262"></a><tt class="py-lineno"> 262</tt>  <tt class="py-line">         </tt>
<a name="L263"></a><tt class="py-lineno"> 263</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_parent_bib</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L264"></a><tt class="py-lineno"> 264</tt>  <tt class="py-line">        <tt class="py-string">'''The bibliography to which this Record belongs.</tt> </tt>
<a name="L265"></a><tt class="py-lineno"> 265</tt>  <tt class="py-line"><tt class="py-string">        @type: L{Bibliography} or C{None}</tt> </tt>
<a name="L266"></a><tt class="py-lineno"> 266</tt>  <tt class="py-line"><tt class="py-string">        '''</tt> </tt>
<a name="L267"></a><tt class="py-lineno"> 267</tt>  <tt class="py-line">         </tt>
<a name="L268"></a><tt class="py-lineno"> 268</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">parent_bib_id</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L269"></a><tt class="py-lineno"> 269</tt>  <tt class="py-line">        <tt class="py-string">'''The id of the parent bibliography.</tt> </tt>
<a name="L270"></a><tt class="py-lineno"> 270</tt>  <tt class="py-line"><tt class="py-string">        </tt> </tt>
<a name="L271"></a><tt class="py-lineno"> 271</tt>  <tt class="py-line"><tt class="py-string">        This will always be set when the parent bib is set, but it may</tt> </tt>
<a name="L272"></a><tt class="py-lineno"> 272</tt>  <tt class="py-line"><tt class="py-string">        sometimes be useful to set this without setting the parent_bib,</tt> </tt>
<a name="L273"></a><tt class="py-lineno"> 273</tt>  <tt class="py-line"><tt class="py-string">        for example, when loading the parent bib into memory might be</tt> </tt>
<a name="L274"></a><tt class="py-lineno"> 274</tt>  <tt class="py-line"><tt class="py-string">        undesirable.</tt> </tt>
<a name="L275"></a><tt class="py-lineno"> 275</tt>  <tt class="py-line"><tt class="py-string">        '''</tt> </tt>
<a name="L276"></a><tt class="py-lineno"> 276</tt>  <tt class="py-line">         </tt>
<a name="L277"></a><tt class="py-lineno"> 277</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">attribute_map</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L278"></a><tt class="py-lineno"> 278</tt>  <tt class="py-line">        <tt class="py-string">'''A dictionary mapping attribute names to their values.</tt> </tt>
<a name="L279"></a><tt class="py-lineno"> 279</tt>  <tt class="py-line"><tt class="py-string">        </tt> </tt>
<a name="L280"></a><tt class="py-lineno"> 280</tt>  <tt class="py-line"><tt class="py-string">        @type: C{dict}</tt> </tt>
<a name="L281"></a><tt class="py-lineno"> 281</tt>  <tt class="py-line"><tt class="py-string">        @warning:</tt> </tt>
<a name="L282"></a><tt class="py-lineno"> 282</tt>  <tt class="py-line"><tt class="py-string">            This attribute should not be modified! New attributes may be</tt> </tt>
<a name="L283"></a><tt class="py-lineno"> 283</tt>  <tt class="py-line"><tt class="py-string">            added or modified using bracket notation:</tt> </tt>
<a name="L284"></a><tt class="py-lineno"> 284</tt>  <tt class="py-line"><tt class="py-string">               &gt;&gt;&gt; record[attribute_name] = value</tt> </tt>
<a name="L285"></a><tt class="py-lineno"> 285</tt>  <tt class="py-line"><tt class="py-string">        '''</tt> </tt>
<a name="L286"></a><tt class="py-lineno"> 286</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">attribute_map</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L287"></a><tt class="py-lineno"> 287</tt>  <tt class="py-line">            <tt class="py-keyword">for</tt> <tt class="py-name">attribute</tt><tt class="py-op">,</tt> <tt class="py-name">value</tt> <tt class="py-keyword">in</tt> <tt class="py-name">attribute_map</tt><tt class="py-op">.</tt><tt class="py-name">items</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L288"></a><tt class="py-lineno"> 288</tt>  <tt class="py-line">                <tt class="py-name">self</tt><tt class="py-op">[</tt><tt class="py-name">attribute</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">value</tt> </tt>
<a name="L289"></a><tt class="py-lineno"> 289</tt>  <tt class="py-line">         </tt>
<a name="L290"></a><tt class="py-lineno"> 290</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-79" class="py-name" targets="Method bkn.bibtex.bibliography.Record.attribute_is_blank()=bkn.bibtex.bibliography.Record-class.html#attribute_is_blank"><a title="bkn.bibtex.bibliography.Record.attribute_is_blank" class="py-name" href="#" onclick="return doclink('link-79', 'attribute_is_blank', 'link-79');">attribute_is_blank</a></tt><tt class="py-op">(</tt><tt class="py-string">u'type'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L291"></a><tt class="py-lineno"> 291</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">bibtype</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L292"></a><tt class="py-lineno"> 292</tt>  <tt class="py-line">                <tt class="py-name">bibtype</tt> <tt class="py-op">=</tt> <tt class="py-string">u'UNKNOWN'</tt> </tt>
<a name="L293"></a><tt class="py-lineno"> 293</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">[</tt><tt class="py-string">u'type'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">bibtype</tt> </tt>
<a name="L294"></a><tt class="py-lineno"> 294</tt>  <tt class="py-line">         </tt>
<a name="L295"></a><tt class="py-lineno"> 295</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-80" class="py-name"><a title="bkn.bibtex.bibliography.Record.attribute_is_blank" class="py-name" href="#" onclick="return doclink('link-80', 'attribute_is_blank', 'link-79');">attribute_is_blank</a></tt><tt class="py-op">(</tt><tt class="py-string">u'id'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L296"></a><tt class="py-lineno"> 296</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">citekey</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L297"></a><tt class="py-lineno"> 297</tt>  <tt class="py-line">                <tt class="py-keyword">raise</tt> <tt id="link-81" class="py-name"><a title="bkn.bibtex.error.BKNBibtexError" class="py-name" href="#" onclick="return doclink('link-81', 'BKNBibtexError', 'link-23');">BKNBibtexError</a></tt><tt class="py-op">(</tt> </tt>
<a name="L298"></a><tt class="py-lineno"> 298</tt>  <tt class="py-line">                    <tt class="py-string">'You must provide an id, either in the attributes or using the citekey keyword argument.'</tt><tt class="py-op">)</tt> </tt>
<a name="L299"></a><tt class="py-lineno"> 299</tt>  <tt class="py-line">                    <tt class="py-comment"># consider subclassing BKNBibtexError</tt> </tt>
<a name="L300"></a><tt class="py-lineno"> 300</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">[</tt><tt class="py-string">u'id'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">citekey</tt> </tt>
</div><a name="L301"></a><tt class="py-lineno"> 301</tt>  <tt class="py-line">         </tt>
<a name="Record.__str__"></a><div id="Record.__str__-def"><a name="L302"></a><tt class="py-lineno"> 302</tt> <a class="py-toggle" href="#" id="Record.__str__-toggle" onclick="return toggle('Record.__str__');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography.Record-class.html#__str__">__str__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Record.__str__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Record.__str__-expanded"><a name="L303"></a><tt class="py-lineno"> 303</tt>  <tt class="py-line">        <tt class="py-docstring">'''Returns an informal string representation of this record</tt> </tt>
<a name="L304"></a><tt class="py-lineno"> 304</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L305"></a><tt class="py-lineno"> 305</tt>  <tt class="py-line"><tt class="py-docstring">        @return:</tt> </tt>
<a name="L306"></a><tt class="py-lineno"> 306</tt>  <tt class="py-line"><tt class="py-docstring">            The current implementation calls to_bibtex(). (This may</tt> </tt>
<a name="L307"></a><tt class="py-lineno"> 307</tt>  <tt class="py-line"><tt class="py-docstring">            change in future versions.</tt> </tt>
<a name="L308"></a><tt class="py-lineno"> 308</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: C{str}</tt> </tt>
<a name="L309"></a><tt class="py-lineno"> 309</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L310"></a><tt class="py-lineno"> 310</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-82" class="py-name" targets="Method bkn.bibtex.bibliography.Bibliography.to_bibtex()=bkn.bibtex.bibliography.Bibliography-class.html#to_bibtex,Method bkn.bibtex.bibliography.Record.to_bibtex()=bkn.bibtex.bibliography.Record-class.html#to_bibtex"><a title="bkn.bibtex.bibliography.Bibliography.to_bibtex
bkn.bibtex.bibliography.Record.to_bibtex" class="py-name" href="#" onclick="return doclink('link-82', 'to_bibtex', 'link-82');">to_bibtex</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L311"></a><tt class="py-lineno"> 311</tt>  <tt class="py-line">         </tt>
<a name="L312"></a><tt class="py-lineno"> 312</tt>  <tt class="py-line">    <tt class="py-comment">#{ Container methods</tt> </tt>
<a name="L313"></a><tt class="py-lineno"> 313</tt>  <tt class="py-line">     </tt>
<a name="Record.__getitem__"></a><div id="Record.__getitem__-def"><a name="L314"></a><tt class="py-lineno"> 314</tt> <a class="py-toggle" href="#" id="Record.__getitem__-toggle" onclick="return toggle('Record.__getitem__');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography.Record-class.html#__getitem__">__getitem__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">attribute_name</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Record.__getitem__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Record.__getitem__-expanded"><a name="L315"></a><tt class="py-lineno"> 315</tt>  <tt class="py-line">        <tt class="py-docstring">'''Returns the value of an attribute. Called when using bracket notation.</tt> </tt>
<a name="L316"></a><tt class="py-lineno"> 316</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L317"></a><tt class="py-lineno"> 317</tt>  <tt class="py-line"><tt class="py-docstring">            &gt;&gt;&gt; record[u'author']</tt> </tt>
<a name="L318"></a><tt class="py-lineno"> 318</tt>  <tt class="py-line"><tt class="py-docstring">            ... "Monty Python"</tt> </tt>
<a name="L319"></a><tt class="py-lineno"> 319</tt>  <tt class="py-line"><tt class="py-docstring">            &gt;&gt;&gt; record[u'title']</tt> </tt>
<a name="L320"></a><tt class="py-lineno"> 320</tt>  <tt class="py-line"><tt class="py-docstring">            ... "Monty Python and the Holy Grail"</tt> </tt>
<a name="L321"></a><tt class="py-lineno"> 321</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L322"></a><tt class="py-lineno"> 322</tt>  <tt class="py-line"><tt class="py-docstring">        @param attribute_name:</tt> </tt>
<a name="L323"></a><tt class="py-lineno"> 323</tt>  <tt class="py-line"><tt class="py-docstring">            the name of the attribute whose value should be returned.</tt> </tt>
<a name="L324"></a><tt class="py-lineno"> 324</tt>  <tt class="py-line"><tt class="py-docstring">        @type attribute_name:</tt> </tt>
<a name="L325"></a><tt class="py-lineno"> 325</tt>  <tt class="py-line"><tt class="py-docstring">            str</tt> </tt>
<a name="L326"></a><tt class="py-lineno"> 326</tt>  <tt class="py-line"><tt class="py-docstring">        @return: the value of the requested attribute.</tt> </tt>
<a name="L327"></a><tt class="py-lineno"> 327</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: C{object}</tt> </tt>
<a name="L328"></a><tt class="py-lineno"> 328</tt>  <tt class="py-line"><tt class="py-docstring">        @raises BadAttributeNameError:</tt> </tt>
<a name="L329"></a><tt class="py-lineno"> 329</tt>  <tt class="py-line"><tt class="py-docstring">            if C{attribute_name} is not a valid attribute name</tt> </tt>
<a name="L330"></a><tt class="py-lineno"> 330</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L331"></a><tt class="py-lineno"> 331</tt>  <tt class="py-line">        <tt id="link-83" class="py-name"><a title="bkn.bibtex.utilities.ensure_objects_are_unicode" class="py-name" href="#" onclick="return doclink('link-83', 'ensure_objects_are_unicode', 'link-8');">ensure_objects_are_unicode</a></tt><tt class="py-op">(</tt><tt class="py-name">attribute_name</tt><tt class="py-op">)</tt> </tt>
<a name="L332"></a><tt class="py-lineno"> 332</tt>  <tt class="py-line">        <tt id="link-84" class="py-name"><a title="bkn.bibtex.bibliography.Record" class="py-name" href="#" onclick="return doclink('link-84', 'Record', 'link-62');">Record</a></tt><tt class="py-op">.</tt><tt id="link-85" class="py-name" targets="Static Method bkn.bibtex.bibliography.Record.validate_attribute_name()=bkn.bibtex.bibliography.Record-class.html#validate_attribute_name"><a title="bkn.bibtex.bibliography.Record.validate_attribute_name" class="py-name" href="#" onclick="return doclink('link-85', 'validate_attribute_name', 'link-85');">validate_attribute_name</a></tt><tt class="py-op">(</tt><tt class="py-name">attribute_name</tt><tt class="py-op">)</tt> </tt>
<a name="L333"></a><tt class="py-lineno"> 333</tt>  <tt class="py-line">        <tt class="py-name">name</tt> <tt class="py-op">=</tt> <tt class="py-name">attribute_name</tt><tt class="py-op">.</tt><tt class="py-name">lower</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L334"></a><tt class="py-lineno"> 334</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">attribute_map</tt><tt class="py-op">.</tt><tt class="py-name">has_key</tt><tt class="py-op">(</tt><tt class="py-name">name</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L335"></a><tt class="py-lineno"> 335</tt>  <tt class="py-line">            <tt class="py-name">result</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">attribute_map</tt><tt class="py-op">[</tt><tt class="py-name">name</tt><tt class="py-op">]</tt> </tt>
<a name="L336"></a><tt class="py-lineno"> 336</tt>  <tt class="py-line">            <tt id="link-86" class="py-name"><a title="bkn.bibtex.utilities.assert_objects_are_unicode" class="py-name" href="#" onclick="return doclink('link-86', 'assert_objects_are_unicode', 'link-5');">assert_objects_are_unicode</a></tt><tt class="py-op">(</tt><tt class="py-name">result</tt><tt class="py-op">)</tt> </tt>
<a name="L337"></a><tt class="py-lineno"> 337</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-name">result</tt> </tt>
<a name="L338"></a><tt class="py-lineno"> 338</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-string">u''</tt> </tt>
</div><a name="L339"></a><tt class="py-lineno"> 339</tt>  <tt class="py-line"> </tt>
<a name="Record.__setitem__"></a><div id="Record.__setitem__-def"><a name="L340"></a><tt class="py-lineno"> 340</tt> <a class="py-toggle" href="#" id="Record.__setitem__-toggle" onclick="return toggle('Record.__setitem__');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography.Record-class.html#__setitem__">__setitem__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">attribute_name</tt><tt class="py-op">,</tt> <tt class="py-param">attribute_value</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Record.__setitem__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Record.__setitem__-expanded"><a name="L341"></a><tt class="py-lineno"> 341</tt>  <tt class="py-line">        <tt class="py-docstring">'''Sets the value of an attribute. Called when using bracket notation.</tt> </tt>
<a name="L342"></a><tt class="py-lineno"> 342</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L343"></a><tt class="py-lineno"> 343</tt>  <tt class="py-line"><tt class="py-docstring">            &gt;&gt;&gt; record[u'id'] = '25'</tt> </tt>
<a name="L344"></a><tt class="py-lineno"> 344</tt>  <tt class="py-line"><tt class="py-docstring">            &gt;&gt;&gt; record[u'type'] = 'article'</tt> </tt>
<a name="L345"></a><tt class="py-lineno"> 345</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L346"></a><tt class="py-lineno"> 346</tt>  <tt class="py-line"><tt class="py-docstring">        @param attribute_name:</tt> </tt>
<a name="L347"></a><tt class="py-lineno"> 347</tt>  <tt class="py-line"><tt class="py-docstring">            the name of the attribute whose value should be set.</tt> </tt>
<a name="L348"></a><tt class="py-lineno"> 348</tt>  <tt class="py-line"><tt class="py-docstring">        @type attribute_name:</tt> </tt>
<a name="L349"></a><tt class="py-lineno"> 349</tt>  <tt class="py-line"><tt class="py-docstring">            str</tt> </tt>
<a name="L350"></a><tt class="py-lineno"> 350</tt>  <tt class="py-line"><tt class="py-docstring">        @param attribute_value:</tt> </tt>
<a name="L351"></a><tt class="py-lineno"> 351</tt>  <tt class="py-line"><tt class="py-docstring">            the value to which the attribute should be set.</tt> </tt>
<a name="L352"></a><tt class="py-lineno"> 352</tt>  <tt class="py-line"><tt class="py-docstring">        @type attribute_value:</tt> </tt>
<a name="L353"></a><tt class="py-lineno"> 353</tt>  <tt class="py-line"><tt class="py-docstring">            object</tt> </tt>
<a name="L354"></a><tt class="py-lineno"> 354</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: C{None}</tt> </tt>
<a name="L355"></a><tt class="py-lineno"> 355</tt>  <tt class="py-line"><tt class="py-docstring">        @raises BadAttributeNameError:</tt> </tt>
<a name="L356"></a><tt class="py-lineno"> 356</tt>  <tt class="py-line"><tt class="py-docstring">            if C{attribute_name} is not a valid attribute name</tt> </tt>
<a name="L357"></a><tt class="py-lineno"> 357</tt>  <tt class="py-line"><tt class="py-docstring">        @todo:</tt> </tt>
<a name="L358"></a><tt class="py-lineno"> 358</tt>  <tt class="py-line"><tt class="py-docstring">            use schema to check object attribute_value for allowed</tt> </tt>
<a name="L359"></a><tt class="py-lineno"> 359</tt>  <tt class="py-line"><tt class="py-docstring">            values.</tt> </tt>
<a name="L360"></a><tt class="py-lineno"> 360</tt>  <tt class="py-line"><tt class="py-docstring">        @todo:</tt> </tt>
<a name="L361"></a><tt class="py-lineno"> 361</tt>  <tt class="py-line"><tt class="py-docstring">            this method is long and confusing. it should be refactored.</tt> </tt>
<a name="L362"></a><tt class="py-lineno"> 362</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L363"></a><tt class="py-lineno"> 363</tt>  <tt class="py-line">        <tt id="link-87" class="py-name"><a title="bkn.bibtex.utilities.ensure_objects_are_unicode" class="py-name" href="#" onclick="return doclink('link-87', 'ensure_objects_are_unicode', 'link-8');">ensure_objects_are_unicode</a></tt><tt class="py-op">(</tt><tt class="py-name">attribute_name</tt><tt class="py-op">,</tt> <tt class="py-name">attribute_value</tt><tt class="py-op">)</tt>         </tt>
<a name="L364"></a><tt class="py-lineno"> 364</tt>  <tt class="py-line">        <tt id="link-88" class="py-name"><a title="bkn.bibtex.bibliography.Record" class="py-name" href="#" onclick="return doclink('link-88', 'Record', 'link-62');">Record</a></tt><tt class="py-op">.</tt><tt id="link-89" class="py-name"><a title="bkn.bibtex.bibliography.Record.validate_attribute_name" class="py-name" href="#" onclick="return doclink('link-89', 'validate_attribute_name', 'link-85');">validate_attribute_name</a></tt><tt class="py-op">(</tt><tt class="py-name">attribute_name</tt><tt class="py-op">)</tt>         </tt>
<a name="L365"></a><tt class="py-lineno"> 365</tt>  <tt class="py-line">        <tt class="py-name">name</tt> <tt class="py-op">=</tt> <tt class="py-name">attribute_name</tt><tt class="py-op">.</tt><tt class="py-name">lower</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-comment"># attribute names are case-insensitive</tt> </tt>
<a name="L366"></a><tt class="py-lineno"> 366</tt>  <tt class="py-line">         </tt>
<a name="L367"></a><tt class="py-lineno"> 367</tt>  <tt class="py-line">        <tt class="py-comment"># Check for duplicates ids</tt> </tt>
<a name="L368"></a><tt class="py-lineno"> 368</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_parent_bib</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L369"></a><tt class="py-lineno"> 369</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">name</tt> <tt class="py-op">==</tt> <tt class="py-string">'id'</tt><tt class="py-op">:</tt> </tt>
<a name="L370"></a><tt class="py-lineno"> 370</tt>  <tt class="py-line">                <tt class="py-keyword">if</tt> <tt class="py-name">attribute_value</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_parent_bib</tt><tt class="py-op">.</tt><tt class="py-name">id_to_record_index</tt><tt class="py-op">.</tt><tt class="py-name">keys</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L371"></a><tt class="py-lineno"> 371</tt>  <tt class="py-line">                    <tt class="py-keyword">if</tt> <tt class="py-name">self</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_parent_bib</tt><tt class="py-op">.</tt><tt class="py-name">id_to_record_index</tt><tt class="py-op">[</tt><tt class="py-name">attribute_value</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
<a name="L372"></a><tt class="py-lineno"> 372</tt>  <tt class="py-line">                        <tt class="py-keyword">raise</tt> <tt id="link-90" class="py-name"><a title="bkn.bibtex.error.BKNBibtexError" class="py-name" href="#" onclick="return doclink('link-90', 'BKNBibtexError', 'link-23');">BKNBibtexError</a></tt><tt class="py-op">(</tt> </tt>
<a name="L373"></a><tt class="py-lineno"> 373</tt>  <tt class="py-line">                            <tt class="py-string">'A record with id '</tt> <tt class="py-op">+</tt> <tt class="py-name">repr</tt><tt class="py-op">(</tt><tt class="py-name">attribute_value</tt><tt class="py-op">)</tt> <tt class="py-op">+</tt> </tt>
<a name="L374"></a><tt class="py-lineno"> 374</tt>  <tt class="py-line">                            <tt class="py-string">' already exists!'</tt><tt class="py-op">)</tt> </tt>
<a name="L375"></a><tt class="py-lineno"> 375</tt>  <tt class="py-line">                        <tt class="py-comment"># should subclass BKNBibtexError</tt> </tt>
<a name="L376"></a><tt class="py-lineno"> 376</tt>  <tt class="py-line">         </tt>
<a name="L377"></a><tt class="py-lineno"> 377</tt>  <tt class="py-line">        <tt class="py-comment"># validate record:</tt> </tt>
<a name="L378"></a><tt class="py-lineno"> 378</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-91" class="py-name" targets="Method bkn.bibtex.bibliography.Record.validate()=bkn.bibtex.bibliography.Record-class.html#validate"><a title="bkn.bibtex.bibliography.Record.validate" class="py-name" href="#" onclick="return doclink('link-91', 'validate', 'link-91');">validate</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L379"></a><tt class="py-lineno"> 379</tt>  <tt class="py-line">         </tt>
<a name="L380"></a><tt class="py-lineno"> 380</tt>  <tt class="py-line">        <tt class="py-name">old_value</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">[</tt><tt class="py-name">name</tt><tt class="py-op">]</tt> </tt>
<a name="L381"></a><tt class="py-lineno"> 381</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">attribute_map</tt><tt class="py-op">[</tt><tt class="py-name">name</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">attribute_value</tt> </tt>
<a name="L382"></a><tt class="py-lineno"> 382</tt>  <tt class="py-line"> </tt>
<a name="L383"></a><tt class="py-lineno"> 383</tt>  <tt class="py-line">        <tt class="py-comment"># update id_to_record_index</tt> </tt>
<a name="L384"></a><tt class="py-lineno"> 384</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">name</tt> <tt class="py-op">==</tt> <tt class="py-string">'id'</tt><tt class="py-op">:</tt> </tt>
<a name="L385"></a><tt class="py-lineno"> 385</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_parent_bib</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L386"></a><tt class="py-lineno"> 386</tt>  <tt class="py-line">                <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L387"></a><tt class="py-lineno"> 387</tt>  <tt class="py-line">                    <tt class="py-keyword">del</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_parent_bib</tt><tt class="py-op">.</tt><tt class="py-name">id_to_record_index</tt><tt class="py-op">[</tt><tt class="py-name">old_value</tt><tt class="py-op">]</tt> </tt>
<a name="L388"></a><tt class="py-lineno"> 388</tt>  <tt class="py-line">                <tt class="py-keyword">except</tt> <tt class="py-name">KeyError</tt><tt class="py-op">:</tt> </tt>
<a name="L389"></a><tt class="py-lineno"> 389</tt>  <tt class="py-line">                    <tt class="py-keyword">pass</tt> </tt>
<a name="L390"></a><tt class="py-lineno"> 390</tt>  <tt class="py-line">                <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_parent_bib</tt><tt class="py-op">.</tt><tt class="py-name">id_to_record_index</tt><tt class="py-op">[</tt><tt class="py-name">self</tt><tt class="py-op">[</tt><tt class="py-name">name</tt><tt class="py-op">]</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt> </tt>
</div><a name="L391"></a><tt class="py-lineno"> 391</tt>  <tt class="py-line">         </tt>
<a name="Record.__delitem__"></a><div id="Record.__delitem__-def"><a name="L392"></a><tt class="py-lineno"> 392</tt> <a class="py-toggle" href="#" id="Record.__delitem__-toggle" onclick="return toggle('Record.__delitem__');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography.Record-class.html#__delitem__">__delitem__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">attribute_name</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Record.__delitem__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Record.__delitem__-expanded"><a name="L393"></a><tt class="py-lineno"> 393</tt>  <tt class="py-line">        <tt class="py-docstring">'''Removes an attribute from the record. Called when using bracket notation.</tt> </tt>
<a name="L394"></a><tt class="py-lineno"> 394</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L395"></a><tt class="py-lineno"> 395</tt>  <tt class="py-line"><tt class="py-docstring">            &gt;&gt;&gt; del record['issn']</tt> </tt>
<a name="L396"></a><tt class="py-lineno"> 396</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L397"></a><tt class="py-lineno"> 397</tt>  <tt class="py-line"><tt class="py-docstring">        @param attribute_name:</tt> </tt>
<a name="L398"></a><tt class="py-lineno"> 398</tt>  <tt class="py-line"><tt class="py-docstring">            the name of the attribute to be removed.</tt> </tt>
<a name="L399"></a><tt class="py-lineno"> 399</tt>  <tt class="py-line"><tt class="py-docstring">        @type attribute_name:</tt> </tt>
<a name="L400"></a><tt class="py-lineno"> 400</tt>  <tt class="py-line"><tt class="py-docstring">            str</tt> </tt>
<a name="L401"></a><tt class="py-lineno"> 401</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: C{None}</tt> </tt>
<a name="L402"></a><tt class="py-lineno"> 402</tt>  <tt class="py-line"><tt class="py-docstring">        @raises BadAttributeNameError:</tt> </tt>
<a name="L403"></a><tt class="py-lineno"> 403</tt>  <tt class="py-line"><tt class="py-docstring">            if C{attribute_name} is not a valid attribute name</tt> </tt>
<a name="L404"></a><tt class="py-lineno"> 404</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L405"></a><tt class="py-lineno"> 405</tt>  <tt class="py-line">        <tt id="link-92" class="py-name"><a title="bkn.bibtex.utilities.ensure_objects_are_unicode" class="py-name" href="#" onclick="return doclink('link-92', 'ensure_objects_are_unicode', 'link-8');">ensure_objects_are_unicode</a></tt><tt class="py-op">(</tt><tt class="py-name">attribute_name</tt><tt class="py-op">)</tt>         </tt>
<a name="L406"></a><tt class="py-lineno"> 406</tt>  <tt class="py-line">        <tt id="link-93" class="py-name"><a title="bkn.bibtex.bibliography.Record" class="py-name" href="#" onclick="return doclink('link-93', 'Record', 'link-62');">Record</a></tt><tt class="py-op">.</tt><tt id="link-94" class="py-name"><a title="bkn.bibtex.bibliography.Record.validate_attribute_name" class="py-name" href="#" onclick="return doclink('link-94', 'validate_attribute_name', 'link-85');">validate_attribute_name</a></tt><tt class="py-op">(</tt><tt class="py-name">attribute_name</tt><tt class="py-op">)</tt> </tt>
<a name="L407"></a><tt class="py-lineno"> 407</tt>  <tt class="py-line">        <tt class="py-name">name</tt> <tt class="py-op">=</tt> <tt class="py-name">attribute_name</tt><tt class="py-op">.</tt><tt class="py-name">lower</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L408"></a><tt class="py-lineno"> 408</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">attribute_map</tt><tt class="py-op">.</tt><tt class="py-name">has_key</tt><tt class="py-op">(</tt><tt class="py-name">name</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L409"></a><tt class="py-lineno"> 409</tt>  <tt class="py-line">            <tt class="py-keyword">del</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">attribute_map</tt><tt class="py-op">[</tt><tt class="py-name">name</tt><tt class="py-op">]</tt> </tt>
</div><a name="L410"></a><tt class="py-lineno"> 410</tt>  <tt class="py-line">         </tt>
<a name="L411"></a><tt class="py-lineno"> 411</tt>  <tt class="py-line">    <tt class="py-comment">#{ Serialization methods</tt> </tt>
<a name="L412"></a><tt class="py-lineno"> 412</tt>  <tt class="py-line">     </tt>
<a name="Record.to_bibtex"></a><div id="Record.to_bibtex-def"><a name="L413"></a><tt class="py-lineno"> 413</tt> <a class="py-toggle" href="#" id="Record.to_bibtex-toggle" onclick="return toggle('Record.to_bibtex');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography.Record-class.html#to_bibtex">to_bibtex</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Record.to_bibtex-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Record.to_bibtex-expanded"><a name="L414"></a><tt class="py-lineno"> 414</tt>  <tt class="py-line">       <tt class="py-docstring">'''Returns this record serialized as a BibTeX entry.</tt> </tt>
<a name="L415"></a><tt class="py-lineno"> 415</tt>  <tt class="py-line"><tt class="py-docstring">       </tt> </tt>
<a name="L416"></a><tt class="py-lineno"> 416</tt>  <tt class="py-line"><tt class="py-docstring">           &gt;&gt;&gt; record.to_bibtex()</tt> </tt>
<a name="L417"></a><tt class="py-lineno"> 417</tt>  <tt class="py-line"><tt class="py-docstring">           ... "@book{23,</tt> </tt>
<a name="L418"></a><tt class="py-lineno"> 418</tt>  <tt class="py-line"><tt class="py-docstring">           ...    title = {Of Mice and Men},</tt> </tt>
<a name="L419"></a><tt class="py-lineno"> 419</tt>  <tt class="py-line"><tt class="py-docstring">           ...    author = {John Steinbeck}</tt> </tt>
<a name="L420"></a><tt class="py-lineno"> 420</tt>  <tt class="py-line"><tt class="py-docstring">           ...}</tt> </tt>
<a name="L421"></a><tt class="py-lineno"> 421</tt>  <tt class="py-line"><tt class="py-docstring">       </tt> </tt>
<a name="L422"></a><tt class="py-lineno"> 422</tt>  <tt class="py-line"><tt class="py-docstring">       @return:</tt> </tt>
<a name="L423"></a><tt class="py-lineno"> 423</tt>  <tt class="py-line"><tt class="py-docstring">           the BibTeX serialization of this record. (Non-string</tt> </tt>
<a name="L424"></a><tt class="py-lineno"> 424</tt>  <tt class="py-line"><tt class="py-docstring">           attribute values will be converted to JSON.)</tt> </tt>
<a name="L425"></a><tt class="py-lineno"> 425</tt>  <tt class="py-line"><tt class="py-docstring">       @rtype: C{str}</tt> </tt>
<a name="L426"></a><tt class="py-lineno"> 426</tt>  <tt class="py-line"><tt class="py-docstring">       @warning:</tt> </tt>
<a name="L427"></a><tt class="py-lineno"> 427</tt>  <tt class="py-line"><tt class="py-docstring">             Bibliographies with any attribute values which are not strings</tt> </tt>
<a name="L428"></a><tt class="py-lineno"> 428</tt>  <tt class="py-line"><tt class="py-docstring">             or integers may not be serialized in the BibTeX format.</tt> </tt>
<a name="L429"></a><tt class="py-lineno"> 429</tt>  <tt class="py-line"><tt class="py-docstring">       '''</tt>        </tt>
<a name="L430"></a><tt class="py-lineno"> 430</tt>  <tt class="py-line">       <tt class="py-name">keys</tt> <tt class="py-op">=</tt> <tt id="link-95" class="py-name" targets="Function bkn.bibtex.bibliography._sort_with_standard_fields_first()=bkn.bibtex.bibliography-module.html#_sort_with_standard_fields_first"><a title="bkn.bibtex.bibliography._sort_with_standard_fields_first" class="py-name" href="#" onclick="return doclink('link-95', '_sort_with_standard_fields_first', 'link-95');">_sort_with_standard_fields_first</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">attribute_map</tt><tt class="py-op">.</tt><tt class="py-name">keys</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L431"></a><tt class="py-lineno"> 431</tt>  <tt class="py-line">        </tt>
<a name="L432"></a><tt class="py-lineno"> 432</tt>  <tt class="py-line">       <tt class="py-comment"># This second block constructs the BibTeX output.</tt> </tt>
<a name="L433"></a><tt class="py-lineno"> 433</tt>  <tt class="py-line">       <tt class="py-name">out</tt> <tt class="py-op">=</tt> <tt class="py-string">u'@'</tt> <tt class="py-op">+</tt> <tt class="py-name">self</tt><tt class="py-op">[</tt><tt class="py-string">u'type'</tt><tt class="py-op">]</tt> <tt class="py-op">+</tt> <tt class="py-string">u'{'</tt> <tt class="py-op">+</tt> <tt class="py-name">self</tt><tt class="py-op">[</tt><tt class="py-string">u'id'</tt><tt class="py-op">]</tt> <tt class="py-op">+</tt> <tt class="py-string">u',\n'</tt> </tt>
<a name="L434"></a><tt class="py-lineno"> 434</tt>  <tt class="py-line">       <tt class="py-keyword">for</tt> <tt class="py-name">key</tt> <tt class="py-keyword">in</tt> <tt class="py-name">keys</tt><tt class="py-op">:</tt> </tt>
<a name="L435"></a><tt class="py-lineno"> 435</tt>  <tt class="py-line">           <tt class="py-name">attribute_value</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">attribute_map</tt><tt class="py-op">[</tt><tt class="py-name">key</tt><tt class="py-op">]</tt> </tt>
<a name="L436"></a><tt class="py-lineno"> 436</tt>  <tt class="py-line">           <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">attribute_value</tt><tt class="py-op">,</tt> <tt class="py-name">types</tt><tt class="py-op">.</tt><tt class="py-name">StringTypes</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L437"></a><tt class="py-lineno"> 437</tt>  <tt class="py-line">               <tt class="py-name">warnings</tt><tt class="py-op">.</tt><tt class="py-name">warn</tt><tt class="py-op">(</tt> </tt>
<a name="L438"></a><tt class="py-lineno"> 438</tt>  <tt class="py-line">                  <tt class="py-string">'The value of the '</tt> <tt class="py-op">+</tt> <tt class="py-name">key</tt> <tt class="py-op">+</tt> <tt class="py-string">' attribute will be converted'</tt> <tt class="py-op">+</tt> </tt>
<a name="L439"></a><tt class="py-lineno"> 439</tt>  <tt class="py-line">                  <tt class="py-string">' to a string in BibTeX output. The resulting '</tt> <tt class="py-op">+</tt> </tt>
<a name="L440"></a><tt class="py-lineno"> 440</tt>  <tt class="py-line">                  <tt class="py-string">'serialization may result in a loss of information'</tt><tt class="py-op">,</tt> </tt>
<a name="L441"></a><tt class="py-lineno"> 441</tt>  <tt class="py-line">                  <tt id="link-96" class="py-name"><a title="bkn.bibtex.error.BKNBibtexWarning" class="py-name" href="#" onclick="return doclink('link-96', 'BKNBibtexWarning', 'link-26');">BKNBibtexWarning</a></tt><tt class="py-op">,</tt> <tt class="py-name">stacklevel</tt><tt class="py-op">=</tt><tt class="py-number">2</tt><tt class="py-op">)</tt> </tt>
<a name="L442"></a><tt class="py-lineno"> 442</tt>  <tt class="py-line">               <tt class="py-name">attribute_value</tt> <tt class="py-op">=</tt> <tt class="py-name">json</tt><tt class="py-op">.</tt><tt class="py-name">dumps</tt><tt class="py-op">(</tt><tt class="py-name">attribute_value</tt><tt class="py-op">)</tt> </tt>
<a name="L443"></a><tt class="py-lineno"> 443</tt>  <tt class="py-line">           <tt class="py-name">out</tt> <tt class="py-op">+=</tt> <tt class="py-string">'  '</tt> <tt class="py-op">+</tt> <tt class="py-name">key</tt> <tt class="py-op">+</tt> <tt class="py-string">' = {'</tt> <tt class="py-op">+</tt> <tt class="py-name">attribute_value</tt> <tt class="py-op">+</tt> <tt class="py-string">'},\n'</tt> </tt>
<a name="L444"></a><tt class="py-lineno"> 444</tt>  <tt class="py-line">       <tt class="py-name">out</tt> <tt class="py-op">+=</tt> <tt class="py-string">'}\n'</tt> </tt>
<a name="L445"></a><tt class="py-lineno"> 445</tt>  <tt class="py-line">       <tt id="link-97" class="py-name"><a title="bkn.bibtex.utilities.assert_objects_are_unicode" class="py-name" href="#" onclick="return doclink('link-97', 'assert_objects_are_unicode', 'link-5');">assert_objects_are_unicode</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">)</tt>         </tt>
<a name="L446"></a><tt class="py-lineno"> 446</tt>  <tt class="py-line">       <tt class="py-keyword">return</tt> <tt class="py-name">out</tt> </tt>
</div><a name="L447"></a><tt class="py-lineno"> 447</tt>  <tt class="py-line"> </tt>
<a name="L448"></a><tt class="py-lineno"> 448</tt>  <tt class="py-line">    <tt class="py-comment">#{ Information methods</tt> </tt>
<a name="L449"></a><tt class="py-lineno"> 449</tt>  <tt class="py-line">     </tt>
<a name="Record.set_parent_bib"></a><div id="Record.set_parent_bib-def"><a name="L450"></a><tt class="py-lineno"> 450</tt> <a class="py-toggle" href="#" id="Record.set_parent_bib-toggle" onclick="return toggle('Record.set_parent_bib');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography.Record-class.html#set_parent_bib">set_parent_bib</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">bib</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Record.set_parent_bib-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Record.set_parent_bib-expanded"><a name="L451"></a><tt class="py-lineno"> 451</tt>  <tt class="py-line">        <tt class="py-docstring">'''Sets the parent bibliography.</tt> </tt>
<a name="L452"></a><tt class="py-lineno"> 452</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L453"></a><tt class="py-lineno"> 453</tt>  <tt class="py-line"><tt class="py-docstring">        This method also sets parent_bib_id and is prefered to setting</tt> </tt>
<a name="L454"></a><tt class="py-lineno"> 454</tt>  <tt class="py-line"><tt class="py-docstring">        the attribute directly.</tt> </tt>
<a name="L455"></a><tt class="py-lineno"> 455</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L456"></a><tt class="py-lineno"> 456</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">parent_bib_id</tt> <tt class="py-op">=</tt> <tt class="py-name">bib</tt><tt class="py-op">.</tt><tt class="py-name">metadata</tt><tt class="py-op">[</tt><tt class="py-string">u'id'</tt><tt class="py-op">]</tt> </tt>
<a name="L457"></a><tt class="py-lineno"> 457</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_parent_bib</tt> <tt class="py-op">=</tt> <tt class="py-name">bib</tt> </tt>
</div><a name="L458"></a><tt class="py-lineno"> 458</tt>  <tt class="py-line">     </tt>
<a name="Record.get_parent_bib"></a><div id="Record.get_parent_bib-def"><a name="L459"></a><tt class="py-lineno"> 459</tt> <a class="py-toggle" href="#" id="Record.get_parent_bib-toggle" onclick="return toggle('Record.get_parent_bib');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography.Record-class.html#get_parent_bib">get_parent_bib</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Record.get_parent_bib-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Record.get_parent_bib-expanded"><a name="L460"></a><tt class="py-lineno"> 460</tt>  <tt class="py-line">        <tt class="py-docstring">'''Returns the L{Bibliography} to which this record belongs.</tt> </tt>
<a name="L461"></a><tt class="py-lineno"> 461</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L462"></a><tt class="py-lineno"> 462</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_parent_bib</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L463"></a><tt class="py-lineno"> 463</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_parent_bib</tt> </tt>
<a name="L464"></a><tt class="py-lineno"> 464</tt>  <tt class="py-line">        <tt class="py-keyword">elif</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">parent_bib_id</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L465"></a><tt class="py-lineno"> 465</tt>  <tt class="py-line">            <tt class="py-name">result</tt> <tt class="py-op">=</tt> <tt id="link-98" class="py-name" targets="Function bkn.bibtex.bibliography.bibliography_from_id()=bkn.bibtex.bibliography-module.html#bibliography_from_id"><a title="bkn.bibtex.bibliography.bibliography_from_id" class="py-name" href="#" onclick="return doclink('link-98', 'bibliography_from_id', 'link-98');">bibliography_from_id</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">parent_bib_id</tt><tt class="py-op">)</tt> </tt>
<a name="L466"></a><tt class="py-lineno"> 466</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-99" class="py-name" targets="Method bkn.bibtex.bibliography.Record.set_parent_bib()=bkn.bibtex.bibliography.Record-class.html#set_parent_bib"><a title="bkn.bibtex.bibliography.Record.set_parent_bib" class="py-name" href="#" onclick="return doclink('link-99', 'set_parent_bib', 'link-99');">set_parent_bib</a></tt><tt class="py-op">(</tt><tt class="py-name">result</tt><tt class="py-op">)</tt> </tt>
<a name="L467"></a><tt class="py-lineno"> 467</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-name">result</tt> </tt>
<a name="L468"></a><tt class="py-lineno"> 468</tt>  <tt class="py-line">        <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L469"></a><tt class="py-lineno"> 469</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
</div><a name="L470"></a><tt class="py-lineno"> 470</tt>  <tt class="py-line"> </tt>
<a name="Record.attribute_is_blank"></a><div id="Record.attribute_is_blank-def"><a name="L471"></a><tt class="py-lineno"> 471</tt> <a class="py-toggle" href="#" id="Record.attribute_is_blank-toggle" onclick="return toggle('Record.attribute_is_blank');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography.Record-class.html#attribute_is_blank">attribute_is_blank</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">attribute_name</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Record.attribute_is_blank-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Record.attribute_is_blank-expanded"><a name="L472"></a><tt class="py-lineno"> 472</tt>  <tt class="py-line">        <tt class="py-docstring">'''Returns True if the supplied attribute is blank.</tt> </tt>
<a name="L473"></a><tt class="py-lineno"> 473</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L474"></a><tt class="py-lineno"> 474</tt>  <tt class="py-line"><tt class="py-docstring">        Returns True if the supplied attribute has a value of None,</tt> </tt>
<a name="L475"></a><tt class="py-lineno"> 475</tt>  <tt class="py-line"><tt class="py-docstring">        whitespace, an empty list, or an empty dict.</tt> </tt>
<a name="L476"></a><tt class="py-lineno"> 476</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L477"></a><tt class="py-lineno"> 477</tt>  <tt class="py-line"><tt class="py-docstring">        @param attribute_name:</tt> </tt>
<a name="L478"></a><tt class="py-lineno"> 478</tt>  <tt class="py-line"><tt class="py-docstring">            the name of the attribute to check.</tt> </tt>
<a name="L479"></a><tt class="py-lineno"> 479</tt>  <tt class="py-line"><tt class="py-docstring">        @type attribute_name:</tt> </tt>
<a name="L480"></a><tt class="py-lineno"> 480</tt>  <tt class="py-line"><tt class="py-docstring">            str</tt> </tt>
<a name="L481"></a><tt class="py-lineno"> 481</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: C{bool}</tt> </tt>
<a name="L482"></a><tt class="py-lineno"> 482</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L483"></a><tt class="py-lineno"> 483</tt>  <tt class="py-line">        <tt id="link-100" class="py-name"><a title="bkn.bibtex.utilities.ensure_objects_are_unicode" class="py-name" href="#" onclick="return doclink('link-100', 'ensure_objects_are_unicode', 'link-8');">ensure_objects_are_unicode</a></tt><tt class="py-op">(</tt><tt class="py-name">attribute_name</tt><tt class="py-op">)</tt>         </tt>
<a name="L484"></a><tt class="py-lineno"> 484</tt>  <tt class="py-line">        <tt id="link-101" class="py-name"><a title="bkn.bibtex.bibliography.Record" class="py-name" href="#" onclick="return doclink('link-101', 'Record', 'link-62');">Record</a></tt><tt class="py-op">.</tt><tt id="link-102" class="py-name"><a title="bkn.bibtex.bibliography.Record.validate_attribute_name" class="py-name" href="#" onclick="return doclink('link-102', 'validate_attribute_name', 'link-85');">validate_attribute_name</a></tt><tt class="py-op">(</tt><tt class="py-name">attribute_name</tt><tt class="py-op">)</tt> </tt>
<a name="L485"></a><tt class="py-lineno"> 485</tt>  <tt class="py-line">        <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L486"></a><tt class="py-lineno"> 486</tt>  <tt class="py-line">            <tt class="py-name">test</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">[</tt><tt class="py-name">attribute_name</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">strip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L487"></a><tt class="py-lineno"> 487</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">test</tt> <tt class="py-op">==</tt> <tt class="py-string">''</tt><tt class="py-op">:</tt> </tt>
<a name="L488"></a><tt class="py-lineno"> 488</tt>  <tt class="py-line">                <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>
<a name="L489"></a><tt class="py-lineno"> 489</tt>  <tt class="py-line">        <tt class="py-keyword">except</tt> <tt class="py-name">AttributeError</tt><tt class="py-op">:</tt> </tt>
<a name="L490"></a><tt class="py-lineno"> 490</tt>  <tt class="py-line">            <tt class="py-keyword">pass</tt> </tt>
<a name="L491"></a><tt class="py-lineno"> 491</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">[</tt><tt class="py-name">attribute_name</tt><tt class="py-op">]</tt> <tt class="py-keyword">in</tt> <tt class="py-op">[</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
<a name="L492"></a><tt class="py-lineno"> 492</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>
<a name="L493"></a><tt class="py-lineno"> 493</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
</div><a name="L494"></a><tt class="py-lineno"> 494</tt>  <tt class="py-line"> </tt>
<a name="Record.attribute_names"></a><div id="Record.attribute_names-def"><a name="L495"></a><tt class="py-lineno"> 495</tt> <a class="py-toggle" href="#" id="Record.attribute_names-toggle" onclick="return toggle('Record.attribute_names');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography.Record-class.html#attribute_names">attribute_names</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Record.attribute_names-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Record.attribute_names-expanded"><a name="L496"></a><tt class="py-lineno"> 496</tt>  <tt class="py-line">       <tt class="py-docstring">'''Returns a list of the field names for each non-empty field in</tt> </tt>
<a name="L497"></a><tt class="py-lineno"> 497</tt>  <tt class="py-line"><tt class="py-docstring">       the Record.</tt> </tt>
<a name="L498"></a><tt class="py-lineno"> 498</tt>  <tt class="py-line"><tt class="py-docstring">       </tt> </tt>
<a name="L499"></a><tt class="py-lineno"> 499</tt>  <tt class="py-line"><tt class="py-docstring">       @return: the names of all the attributes for this Record.</tt> </tt>
<a name="L500"></a><tt class="py-lineno"> 500</tt>  <tt class="py-line"><tt class="py-docstring">       @rtype: C{list}</tt> </tt>
<a name="L501"></a><tt class="py-lineno"> 501</tt>  <tt class="py-line"><tt class="py-docstring">       '''</tt> </tt>
<a name="L502"></a><tt class="py-lineno"> 502</tt>  <tt class="py-line">       <tt class="py-name">result</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">k</tt> <tt class="py-keyword">for</tt> <tt class="py-name">k</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">attribute_map</tt><tt class="py-op">.</tt><tt class="py-name">keys</tt><tt class="py-op">(</tt><tt class="py-op">)</tt>  </tt>
<a name="L503"></a><tt class="py-lineno"> 503</tt>  <tt class="py-line">           <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-103" class="py-name"><a title="bkn.bibtex.bibliography.Record.attribute_is_blank" class="py-name" href="#" onclick="return doclink('link-103', 'attribute_is_blank', 'link-79');">attribute_is_blank</a></tt><tt class="py-op">(</tt><tt class="py-name">k</tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
<a name="L504"></a><tt class="py-lineno"> 504</tt>  <tt class="py-line">       <tt id="link-104" class="py-name"><a title="bkn.bibtex.utilities.assert_objects_are_unicode" class="py-name" href="#" onclick="return doclink('link-104', 'assert_objects_are_unicode', 'link-5');">assert_objects_are_unicode</a></tt><tt class="py-op">(</tt><tt class="py-op">*</tt><tt class="py-name">result</tt><tt class="py-op">)</tt> </tt>
<a name="L505"></a><tt class="py-lineno"> 505</tt>  <tt class="py-line">       <tt class="py-keyword">return</tt> <tt class="py-name">result</tt> </tt>
</div><a name="L506"></a><tt class="py-lineno"> 506</tt>  <tt class="py-line">     </tt>
<a name="Record.fullname"></a><div id="Record.fullname-def"><a name="L507"></a><tt class="py-lineno"> 507</tt> <a class="py-toggle" href="#" id="Record.fullname-toggle" onclick="return toggle('Record.fullname');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography.Record-class.html#fullname">fullname</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Record.fullname-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Record.fullname-expanded"><a name="L508"></a><tt class="py-lineno"> 508</tt>  <tt class="py-line">        <tt class="py-docstring">'''Returns the name of the parent_bib and this records id,</tt> </tt>
<a name="L509"></a><tt class="py-lineno"> 509</tt>  <tt class="py-line"><tt class="py-docstring">        separated by a colon.</tt> </tt>
<a name="L510"></a><tt class="py-lineno"> 510</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L511"></a><tt class="py-lineno"> 511</tt>  <tt class="py-line"><tt class="py-docstring">        @deprecated:</tt> </tt>
<a name="L512"></a><tt class="py-lineno"> 512</tt>  <tt class="py-line"><tt class="py-docstring">             Use the global_id() method instead.</tt> </tt>
<a name="L513"></a><tt class="py-lineno"> 513</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: C{str}</tt> </tt>
<a name="L514"></a><tt class="py-lineno"> 514</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L515"></a><tt class="py-lineno"> 515</tt>  <tt class="py-line">        <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L516"></a><tt class="py-lineno"> 516</tt>  <tt class="py-line">            <tt class="py-name">result</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">parent_bib</tt><tt class="py-op">.</tt><tt class="py-name">id</tt> <tt class="py-op">+</tt> <tt class="py-string">':'</tt> <tt class="py-op">+</tt> <tt class="py-name">self</tt><tt class="py-op">[</tt><tt class="py-string">u'id'</tt><tt class="py-op">]</tt> </tt>
<a name="L517"></a><tt class="py-lineno"> 517</tt>  <tt class="py-line">            <tt id="link-105" class="py-name"><a title="bkn.bibtex.utilities.assert_objects_are_unicode" class="py-name" href="#" onclick="return doclink('link-105', 'assert_objects_are_unicode', 'link-5');">assert_objects_are_unicode</a></tt><tt class="py-op">(</tt><tt class="py-name">result</tt><tt class="py-op">)</tt> </tt>
<a name="L518"></a><tt class="py-lineno"> 518</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-name">result</tt> </tt>
<a name="L519"></a><tt class="py-lineno"> 519</tt>  <tt class="py-line">        <tt class="py-keyword">except</tt> <tt class="py-name">AttributeError</tt><tt class="py-op">:</tt> </tt>
<a name="L520"></a><tt class="py-lineno"> 520</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-string">u'&lt;no parent bib&gt;: '</tt> <tt class="py-op">+</tt> <tt class="py-name">self</tt><tt class="py-op">[</tt><tt class="py-string">u'id'</tt><tt class="py-op">]</tt> </tt>
</div><a name="L521"></a><tt class="py-lineno"> 521</tt>  <tt class="py-line"> </tt>
<a name="Record.global_id"></a><div id="Record.global_id-def"><a name="L522"></a><tt class="py-lineno"> 522</tt> <a class="py-toggle" href="#" id="Record.global_id-toggle" onclick="return toggle('Record.global_id');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography.Record-class.html#global_id">global_id</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Record.global_id-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Record.global_id-expanded"><a name="L523"></a><tt class="py-lineno"> 523</tt>  <tt class="py-line">        <tt class="py-docstring">'''Returns the global id of this record.</tt> </tt>
<a name="L524"></a><tt class="py-lineno"> 524</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L525"></a><tt class="py-lineno"> 525</tt>  <tt class="py-line"><tt class="py-docstring">        @return:</tt> </tt>
<a name="L526"></a><tt class="py-lineno"> 526</tt>  <tt class="py-line"><tt class="py-docstring">            the global is of this record, i.e. the concatenation of the</tt> </tt>
<a name="L527"></a><tt class="py-lineno"> 527</tt>  <tt class="py-line"><tt class="py-docstring">            dataset id and the local id for this record.</tt> </tt>
<a name="L528"></a><tt class="py-lineno"> 528</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: C{str}</tt> </tt>
<a name="L529"></a><tt class="py-lineno"> 529</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L530"></a><tt class="py-lineno"> 530</tt>  <tt class="py-line">        <tt class="py-name">result</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">parent_bib_id</tt> <tt class="py-op">+</tt> <tt class="py-name">self</tt><tt class="py-op">[</tt><tt class="py-string">u'id'</tt><tt class="py-op">]</tt> </tt>
<a name="L531"></a><tt class="py-lineno"> 531</tt>  <tt class="py-line">        <tt id="link-106" class="py-name"><a title="bkn.bibtex.utilities.assert_objects_are_unicode" class="py-name" href="#" onclick="return doclink('link-106', 'assert_objects_are_unicode', 'link-5');">assert_objects_are_unicode</a></tt><tt class="py-op">(</tt><tt class="py-name">result</tt><tt class="py-op">)</tt> </tt>
<a name="L532"></a><tt class="py-lineno"> 532</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">result</tt> </tt>
</div><a name="L533"></a><tt class="py-lineno"> 533</tt>  <tt class="py-line"> </tt>
<a name="Record.names_for_sort"></a><div id="Record.names_for_sort-def"><a name="L534"></a><tt class="py-lineno"> 534</tt> <a class="py-toggle" href="#" id="Record.names_for_sort-toggle" onclick="return toggle('Record.names_for_sort');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography.Record-class.html#names_for_sort">names_for_sort</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Record.names_for_sort-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Record.names_for_sort-expanded"><a name="L535"></a><tt class="py-lineno"> 535</tt>  <tt class="py-line">        <tt class="py-docstring">'''Returns the value of the author attribute if it exists, otherwise returns the value of the editor attribute.</tt> </tt>
<a name="L536"></a><tt class="py-lineno"> 536</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L537"></a><tt class="py-lineno"> 537</tt>  <tt class="py-line"><tt class="py-docstring">        This method may be used when sorting bibliography entries.</tt> </tt>
<a name="L538"></a><tt class="py-lineno"> 538</tt>  <tt class="py-line"><tt class="py-docstring">        @return:</tt> </tt>
<a name="L539"></a><tt class="py-lineno"> 539</tt>  <tt class="py-line"><tt class="py-docstring">            the value of the author attribute if it exists, otherwise</tt> </tt>
<a name="L540"></a><tt class="py-lineno"> 540</tt>  <tt class="py-line"><tt class="py-docstring">            returns the value of the editor attribute.</tt> </tt>
<a name="L541"></a><tt class="py-lineno"> 541</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: C{object}</tt> </tt>
<a name="L542"></a><tt class="py-lineno"> 542</tt>  <tt class="py-line"><tt class="py-docstring">        @note:</tt> </tt>
<a name="L543"></a><tt class="py-lineno"> 543</tt>  <tt class="py-line"><tt class="py-docstring">            The returned object may be of any type but will most often be</tt> </tt>
<a name="L544"></a><tt class="py-lineno"> 544</tt>  <tt class="py-line"><tt class="py-docstring">            a string or a list of strings.</tt> </tt>
<a name="L545"></a><tt class="py-lineno"> 545</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L546"></a><tt class="py-lineno"> 546</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-107" class="py-name"><a title="bkn.bibtex.bibliography.Record.attribute_is_blank" class="py-name" href="#" onclick="return doclink('link-107', 'attribute_is_blank', 'link-79');">attribute_is_blank</a></tt><tt class="py-op">(</tt><tt class="py-string">u'author'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L547"></a><tt class="py-lineno"> 547</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">[</tt><tt class="py-string">u'author'</tt><tt class="py-op">]</tt> </tt>
<a name="L548"></a><tt class="py-lineno"> 548</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">[</tt><tt class="py-string">u'editor'</tt><tt class="py-op">]</tt> </tt>
</div><a name="L549"></a><tt class="py-lineno"> 549</tt>  <tt class="py-line"> </tt>
<a name="Record.values_equal"></a><div id="Record.values_equal-def"><a name="L550"></a><tt class="py-lineno"> 550</tt> <a class="py-toggle" href="#" id="Record.values_equal-toggle" onclick="return toggle('Record.values_equal');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography.Record-class.html#values_equal">values_equal</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">other</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Record.values_equal-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Record.values_equal-expanded"><a name="L551"></a><tt class="py-lineno"> 551</tt>  <tt class="py-line">        <tt class="py-docstring">'''Returns true if this Record has the same content as the given Record.</tt> </tt>
<a name="L552"></a><tt class="py-lineno"> 552</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L553"></a><tt class="py-lineno"> 553</tt>  <tt class="py-line"><tt class="py-docstring">        Distinct Records will always compare as not equal. This method may</tt> </tt>
<a name="L554"></a><tt class="py-lineno"> 554</tt>  <tt class="py-line"><tt class="py-docstring">        be used to compare Records based upon their content.</tt> </tt>
<a name="L555"></a><tt class="py-lineno"> 555</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L556"></a><tt class="py-lineno"> 556</tt>  <tt class="py-line"><tt class="py-docstring">            &gt;&gt;&gt; r1 = Record(attribute_map={u'id' : '1', u'title' : u'Spam' })</tt> </tt>
<a name="L557"></a><tt class="py-lineno"> 557</tt>  <tt class="py-line"><tt class="py-docstring">            &gt;&gt;&gt; r2 = Record(attribute_map={u'id' : '1', u'title' : u'Spam' })</tt> </tt>
<a name="L558"></a><tt class="py-lineno"> 558</tt>  <tt class="py-line"><tt class="py-docstring">            &gt;&gt;&gt; r3 = Record(attribute_map={u'id' : '1', u'title' : u'Eggs' })</tt> </tt>
<a name="L559"></a><tt class="py-lineno"> 559</tt>  <tt class="py-line"><tt class="py-docstring">            &gt;&gt;&gt; r1 == r2</tt> </tt>
<a name="L560"></a><tt class="py-lineno"> 560</tt>  <tt class="py-line"><tt class="py-docstring">            ... False</tt> </tt>
<a name="L561"></a><tt class="py-lineno"> 561</tt>  <tt class="py-line"><tt class="py-docstring">            &gt;&gt;&gt; r1.values_equal(r2)</tt> </tt>
<a name="L562"></a><tt class="py-lineno"> 562</tt>  <tt class="py-line"><tt class="py-docstring">            ... True</tt> </tt>
<a name="L563"></a><tt class="py-lineno"> 563</tt>  <tt class="py-line"><tt class="py-docstring">            &gt;&gt;&gt; r1.values_equal(r3)</tt> </tt>
<a name="L564"></a><tt class="py-lineno"> 564</tt>  <tt class="py-line"><tt class="py-docstring">            ... False</tt> </tt>
<a name="L565"></a><tt class="py-lineno"> 565</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L566"></a><tt class="py-lineno"> 566</tt>  <tt class="py-line"><tt class="py-docstring">        @param other: the Record to which this Record should be compared.</tt> </tt>
<a name="L567"></a><tt class="py-lineno"> 567</tt>  <tt class="py-line"><tt class="py-docstring">        @type other: Record</tt> </tt>
<a name="L568"></a><tt class="py-lineno"> 568</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: C{bool}</tt> </tt>
<a name="L569"></a><tt class="py-lineno"> 569</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L570"></a><tt class="py-lineno"> 570</tt>  <tt class="py-line">        <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L571"></a><tt class="py-lineno"> 571</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-108" class="py-name"><a title="bkn.bibtex.bibliography.Bibliography.to_bibtex
bkn.bibtex.bibliography.Record.to_bibtex" class="py-name" href="#" onclick="return doclink('link-108', 'to_bibtex', 'link-82');">to_bibtex</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-name">other</tt><tt class="py-op">.</tt><tt id="link-109" class="py-name"><a title="bkn.bibtex.bibliography.Bibliography.to_bibtex
bkn.bibtex.bibliography.Record.to_bibtex" class="py-name" href="#" onclick="return doclink('link-109', 'to_bibtex', 'link-82');">to_bibtex</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L572"></a><tt class="py-lineno"> 572</tt>  <tt class="py-line">        <tt class="py-keyword">except</tt> <tt class="py-name">AttributeError</tt><tt class="py-op">:</tt> </tt>
<a name="L573"></a><tt class="py-lineno"> 573</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
</div><a name="L574"></a><tt class="py-lineno"> 574</tt>  <tt class="py-line"> </tt>
<a name="L575"></a><tt class="py-lineno"> 575</tt>  <tt class="py-line">    <tt class="py-comment">#{ methods for handling deprecated attributes</tt> </tt>
<a name="L576"></a><tt class="py-lineno"> 576</tt>  <tt class="py-line"> </tt>
<a name="Record.__getattr__"></a><div id="Record.__getattr__-def"><a name="L577"></a><tt class="py-lineno"> 577</tt> <a class="py-toggle" href="#" id="Record.__getattr__-toggle" onclick="return toggle('Record.__getattr__');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography.Record-class.html#__getattr__">__getattr__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">name</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Record.__getattr__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Record.__getattr__-expanded"><a name="L578"></a><tt class="py-lineno"> 578</tt>  <tt class="py-line">        <tt class="py-docstring">'''Handles attribute access for deprecated attributes and methods.</tt> </tt>
<a name="L579"></a><tt class="py-lineno"> 579</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L580"></a><tt class="py-lineno"> 580</tt>  <tt class="py-line"><tt class="py-docstring">        @param name: the name of the requested attribute.</tt> </tt>
<a name="L581"></a><tt class="py-lineno"> 581</tt>  <tt class="py-line"><tt class="py-docstring">        @type name: str</tt> </tt>
<a name="L582"></a><tt class="py-lineno"> 582</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: C{object}</tt> </tt>
<a name="L583"></a><tt class="py-lineno"> 583</tt>  <tt class="py-line"><tt class="py-docstring">        @raise AttributeError:</tt> </tt>
<a name="L584"></a><tt class="py-lineno"> 584</tt>  <tt class="py-line"><tt class="py-docstring">            if this method does not handle the given attribute name.</tt> </tt>
<a name="L585"></a><tt class="py-lineno"> 585</tt>  <tt class="py-line"><tt class="py-docstring">        @note:</tt> </tt>
<a name="L586"></a><tt class="py-lineno"> 586</tt>  <tt class="py-line"><tt class="py-docstring">            'attribute' in this context refers to a python attribute,</tt> </tt>
<a name="L587"></a><tt class="py-lineno"> 587</tt>  <tt class="py-line"><tt class="py-docstring">            not to a BibJSON attribute.</tt> </tt>
<a name="L588"></a><tt class="py-lineno"> 588</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt>         </tt>
<a name="L589"></a><tt class="py-lineno"> 589</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">name</tt><tt class="py-op">==</tt><tt class="py-string">'citekey'</tt><tt class="py-op">:</tt> </tt>
<a name="L590"></a><tt class="py-lineno"> 590</tt>  <tt class="py-line">            <tt class="py-name">warnings</tt><tt class="py-op">.</tt><tt class="py-name">warn</tt><tt class="py-op">(</tt> </tt>
<a name="L591"></a><tt class="py-lineno"> 591</tt>  <tt class="py-line">                <tt class="py-string">"The citekey attribute has been deprecated. "</tt> <tt class="py-op">+</tt> </tt>
<a name="L592"></a><tt class="py-lineno"> 592</tt>  <tt class="py-line">                <tt class="py-string">"Please use the 'id' field instead."</tt><tt class="py-op">,</tt> </tt>
<a name="L593"></a><tt class="py-lineno"> 593</tt>  <tt class="py-line">                <tt class="py-name">DeprecationWarning</tt><tt class="py-op">,</tt> <tt class="py-name">stacklevel</tt><tt class="py-op">=</tt><tt class="py-number">2</tt><tt class="py-op">)</tt> </tt>
<a name="L594"></a><tt class="py-lineno"> 594</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">[</tt><tt class="py-string">'id'</tt><tt class="py-op">]</tt> </tt>
<a name="L595"></a><tt class="py-lineno"> 595</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">name</tt><tt class="py-op">==</tt><tt class="py-string">'bibtype'</tt><tt class="py-op">:</tt> </tt>
<a name="L596"></a><tt class="py-lineno"> 596</tt>  <tt class="py-line">            <tt class="py-name">warnings</tt><tt class="py-op">.</tt><tt class="py-name">warn</tt><tt class="py-op">(</tt> </tt>
<a name="L597"></a><tt class="py-lineno"> 597</tt>  <tt class="py-line">                <tt class="py-string">"The bibtype attribute has been deprecated. "</tt> <tt class="py-op">+</tt> </tt>
<a name="L598"></a><tt class="py-lineno"> 598</tt>  <tt class="py-line">                <tt class="py-string">"Please use the 'type' field instead."</tt><tt class="py-op">,</tt> </tt>
<a name="L599"></a><tt class="py-lineno"> 599</tt>  <tt class="py-line">                <tt class="py-name">DeprecationWarning</tt><tt class="py-op">,</tt> <tt class="py-name">stacklevel</tt><tt class="py-op">=</tt><tt class="py-number">2</tt><tt class="py-op">)</tt> </tt>
<a name="L600"></a><tt class="py-lineno"> 600</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">[</tt><tt class="py-string">u'type'</tt><tt class="py-op">]</tt> </tt>
<a name="L601"></a><tt class="py-lineno"> 601</tt>  <tt class="py-line">         </tt>
<a name="L602"></a><tt class="py-lineno"> 602</tt>  <tt class="py-line">        <tt class="py-name">deprecated_attributes</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> </tt>
<a name="L603"></a><tt class="py-lineno"> 603</tt>  <tt class="py-line">            <tt class="py-string">'fields'</tt> <tt class="py-op">:</tt> <tt class="py-string">'attribute_map'</tt><tt class="py-op">,</tt> </tt>
<a name="L604"></a><tt class="py-lineno"> 604</tt>  <tt class="py-line">            <tt class="py-string">'field_names'</tt> <tt class="py-op">:</tt> <tt class="py-string">'attribute_names'</tt> </tt>
<a name="L605"></a><tt class="py-lineno"> 605</tt>  <tt class="py-line">        <tt class="py-op">}</tt> </tt>
<a name="L606"></a><tt class="py-lineno"> 606</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">name</tt> <tt class="py-keyword">in</tt> <tt class="py-name">deprecated_attributes</tt><tt class="py-op">.</tt><tt class="py-name">keys</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L607"></a><tt class="py-lineno"> 607</tt>  <tt class="py-line">            <tt class="py-name">warnings</tt><tt class="py-op">.</tt><tt class="py-name">warn</tt><tt class="py-op">(</tt> </tt>
<a name="L608"></a><tt class="py-lineno"> 608</tt>  <tt class="py-line">                <tt class="py-string">'The '</tt> <tt class="py-op">+</tt> <tt class="py-name">name</tt> <tt class="py-op">+</tt> <tt class="py-string">' attribute has been deprecated. '</tt> <tt class="py-op">+</tt> </tt>
<a name="L609"></a><tt class="py-lineno"> 609</tt>  <tt class="py-line">                <tt class="py-string">'Please use "'</tt> <tt class="py-op">+</tt> <tt class="py-name">deprecated_attributes</tt><tt class="py-op">[</tt><tt class="py-name">name</tt><tt class="py-op">]</tt> <tt class="py-op">+</tt> <tt class="py-string">'" instead.'</tt><tt class="py-op">,</tt> </tt>
<a name="L610"></a><tt class="py-lineno"> 610</tt>  <tt class="py-line">                <tt class="py-name">DeprecationWarning</tt><tt class="py-op">,</tt> <tt class="py-name">stacklevel</tt><tt class="py-op">=</tt><tt class="py-number">2</tt><tt class="py-op">)</tt> </tt>
<a name="L611"></a><tt class="py-lineno"> 611</tt>  <tt class="py-line">            <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L612"></a><tt class="py-lineno"> 612</tt>  <tt class="py-line">                <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__dict__</tt><tt class="py-op">[</tt><tt class="py-name">deprecated_attributes</tt><tt class="py-op">[</tt><tt class="py-name">name</tt><tt class="py-op">]</tt><tt class="py-op">]</tt> </tt>
<a name="L613"></a><tt class="py-lineno"> 613</tt>  <tt class="py-line">            <tt class="py-keyword">except</tt> <tt class="py-name">KeyError</tt><tt class="py-op">:</tt> </tt>
<a name="L614"></a><tt class="py-lineno"> 614</tt>  <tt class="py-line">                <tt class="py-comment"># if deprecated_attributes[name] was not found in the</tt> </tt>
<a name="L615"></a><tt class="py-lineno"> 615</tt>  <tt class="py-line">                <tt class="py-comment"># __dict__ for this instance then we assume it was a</tt> </tt>
<a name="L616"></a><tt class="py-lineno"> 616</tt>  <tt class="py-line">                <tt class="py-comment"># method--and methods are stored as attributes of the class.</tt> </tt>
<a name="L617"></a><tt class="py-lineno"> 617</tt>  <tt class="py-line">                <tt class="py-keyword">return</tt> <tt id="link-110" class="py-name"><a title="bkn.bibtex.bibliography.Record" class="py-name" href="#" onclick="return doclink('link-110', 'Record', 'link-62');">Record</a></tt><tt class="py-op">.</tt><tt class="py-name">__dict__</tt><tt class="py-op">[</tt><tt class="py-name">deprecated_attributes</tt><tt class="py-op">[</tt><tt class="py-name">name</tt><tt class="py-op">]</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">__get__</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt id="link-111" class="py-name"><a title="bkn.bibtex.bibliography.Record" class="py-name" href="#" onclick="return doclink('link-111', 'Record', 'link-62');">Record</a></tt><tt class="py-op">)</tt> </tt>
<a name="L618"></a><tt class="py-lineno"> 618</tt>  <tt class="py-line">        <tt class="py-keyword">raise</tt> <tt class="py-name">AttributeError</tt><tt class="py-op">(</tt><tt class="py-name">name</tt><tt class="py-op">)</tt> </tt>
</div><a name="L619"></a><tt class="py-lineno"> 619</tt>  <tt class="py-line">     </tt>
<a name="Record.validate"></a><div id="Record.validate-def"><a name="L620"></a><tt class="py-lineno"> 620</tt> <a class="py-toggle" href="#" id="Record.validate-toggle" onclick="return toggle('Record.validate');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography.Record-class.html#validate">validate</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Record.validate-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Record.validate-expanded"><a name="L621"></a><tt class="py-lineno"> 621</tt>  <tt class="py-line">        <tt class="py-docstring">'''Validates this record.</tt> </tt>
<a name="L622"></a><tt class="py-lineno"> 622</tt>  <tt class="py-line"><tt class="py-docstring">        @todo: add fuctionality.</tt> </tt>
<a name="L623"></a><tt class="py-lineno"> 623</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L624"></a><tt class="py-lineno"> 624</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_parent_bib</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L625"></a><tt class="py-lineno"> 625</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_parent_bib</tt><tt class="py-op">.</tt><tt id="link-112" class="py-name" targets="Method bkn.bibtex.bibliography.Bibliography.validate_record()=bkn.bibtex.bibliography.Bibliography-class.html#validate_record"><a title="bkn.bibtex.bibliography.Bibliography.validate_record" class="py-name" href="#" onclick="return doclink('link-112', 'validate_record', 'link-112');">validate_record</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">)</tt> </tt>
</div><a name="L626"></a><tt class="py-lineno"> 626</tt>  <tt class="py-line">         </tt>
<a name="L627"></a><tt class="py-lineno"> 627</tt>  <tt class="py-line">    <tt class="py-decorator">@</tt><tt class="py-decorator">staticmethod</tt> </tt>
<a name="Record.validate_attribute_name"></a><div id="Record.validate_attribute_name-def"><a name="L628"></a><tt class="py-lineno"> 628</tt> <a class="py-toggle" href="#" id="Record.validate_attribute_name-toggle" onclick="return toggle('Record.validate_attribute_name');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography.Record-class.html#validate_attribute_name">validate_attribute_name</a><tt class="py-op">(</tt><tt class="py-param">attribute_name</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Record.validate_attribute_name-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Record.validate_attribute_name-expanded"><a name="L629"></a><tt class="py-lineno"> 629</tt>  <tt class="py-line">        <tt class="py-docstring">'''Raises a BadAttributeNameError if the supplied string is not a valid attribute name.</tt> </tt>
<a name="L630"></a><tt class="py-lineno"> 630</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L631"></a><tt class="py-lineno"> 631</tt>  <tt class="py-line"><tt class="py-docstring">        @param attribute_name: a potential attribute name</tt> </tt>
<a name="L632"></a><tt class="py-lineno"> 632</tt>  <tt class="py-line"><tt class="py-docstring">        @type attribute_name: C{Unicode}</tt> </tt>
<a name="L633"></a><tt class="py-lineno"> 633</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: C{None}</tt> </tt>
<a name="L634"></a><tt class="py-lineno"> 634</tt>  <tt class="py-line"><tt class="py-docstring">        @raises BadAttributeNameError:</tt> </tt>
<a name="L635"></a><tt class="py-lineno"> 635</tt>  <tt class="py-line"><tt class="py-docstring">            if attribute_name is not a valid attribute name.</tt> </tt>
<a name="L636"></a><tt class="py-lineno"> 636</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L637"></a><tt class="py-lineno"> 637</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-op">(</tt><tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">attribute_name</tt><tt class="py-op">,</tt> <tt class="py-name">types</tt><tt class="py-op">.</tt><tt class="py-name">UnicodeType</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L638"></a><tt class="py-lineno"> 638</tt>  <tt class="py-line">            <tt class="py-keyword">raise</tt> <tt id="link-113" class="py-name"><a title="bkn.bibtex.error.BadAttributeNameError" class="py-name" href="#" onclick="return doclink('link-113', 'BadAttributeNameError', 'link-14');">BadAttributeNameError</a></tt><tt class="py-op">(</tt><tt class="py-string">'Attribute names must be Unicode strings'</tt><tt class="py-op">)</tt> </tt>
<a name="L639"></a><tt class="py-lineno"> 639</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">attribute_name</tt> <tt class="py-op">==</tt> <tt class="py-string">''</tt><tt class="py-op">:</tt> </tt>
<a name="L640"></a><tt class="py-lineno"> 640</tt>  <tt class="py-line">            <tt class="py-keyword">raise</tt> <tt id="link-114" class="py-name"><a title="bkn.bibtex.error.BadAttributeNameError" class="py-name" href="#" onclick="return doclink('link-114', 'BadAttributeNameError', 'link-14');">BadAttributeNameError</a></tt><tt class="py-op">(</tt><tt class="py-string">'Attribute names must not be empty'</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L641"></a><tt class="py-lineno"> 641</tt>  <tt class="py-line"> </tt>
<a name="BibEntry"></a><div id="BibEntry-def"><a name="L642"></a><tt class="py-lineno"> 642</tt>  <tt class="py-line"> </tt>
<a name="L643"></a><tt class="py-lineno"> 643</tt> <a class="py-toggle" href="#" id="BibEntry-toggle" onclick="return toggle('BibEntry');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="bkn.bibtex.bibliography.BibEntry-class.html">BibEntry</a><tt class="py-op">(</tt><tt class="py-base-class">Record</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="BibEntry-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="BibEntry-expanded"><a name="L644"></a><tt class="py-lineno"> 644</tt>  <tt class="py-line">    <tt class="py-docstring">'''(DEPRECATED) BibEntry is a alias for the L{Record} class.</tt> </tt>
<a name="L645"></a><tt class="py-lineno"> 645</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L646"></a><tt class="py-lineno"> 646</tt>  <tt class="py-line"><tt class="py-docstring">    @deprecated:</tt> </tt>
<a name="L647"></a><tt class="py-lineno"> 647</tt>  <tt class="py-line"><tt class="py-docstring">        This class has been renamed 'Record' to match the vocabulary used</tt> </tt>
<a name="L648"></a><tt class="py-lineno"> 648</tt>  <tt class="py-line"><tt class="py-docstring">        by BibJSON.</tt> </tt>
<a name="L649"></a><tt class="py-lineno"> 649</tt>  <tt class="py-line"><tt class="py-docstring">    '''</tt> </tt>
<a name="BibEntry.__init__"></a><div id="BibEntry.__init__-def"><a name="L650"></a><tt class="py-lineno"> 650</tt> <a class="py-toggle" href="#" id="BibEntry.__init__-toggle" onclick="return toggle('BibEntry.__init__');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography.BibEntry-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">citekey</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">bibtype</tt><tt class="py-op">=</tt><tt class="py-string">'UNKNOWN'</tt><tt class="py-op">,</tt> <tt class="py-param">fields</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="BibEntry.__init__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="BibEntry.__init__-expanded"><a name="L651"></a><tt class="py-lineno"> 651</tt>  <tt class="py-line">        <tt class="py-docstring">'''Calls the __init__() method for the Record class and issues a DeprecationWarning.'''</tt> </tt>
<a name="L652"></a><tt class="py-lineno"> 652</tt>  <tt class="py-line">        <tt id="link-115" class="py-name"><a title="bkn.bibtex.bibliography.Record" class="py-name" href="#" onclick="return doclink('link-115', 'Record', 'link-62');">Record</a></tt><tt class="py-op">.</tt><tt id="link-116" class="py-name" targets="Method bkn.bibtex.bibliography.BibEntry.__init__()=bkn.bibtex.bibliography.BibEntry-class.html#__init__,Method bkn.bibtex.bibliography.Bibliography.__init__()=bkn.bibtex.bibliography.Bibliography-class.html#__init__,Method bkn.bibtex.bibliography.Record.__init__()=bkn.bibtex.bibliography.Record-class.html#__init__,Method bkn.bibtex.bibliography._AddBibtexOutputEnchancer.__init__()=bkn.bibtex.bibliography._AddBibtexOutputEnchancer-class.html#__init__,Method bkn.bibtex.error.AttributeCollisionWarning.__init__()=bkn.bibtex.error.AttributeCollisionWarning-class.html#__init__,Method bkn.bibtex.error.BibFileSyntaxError.__init__()=bkn.bibtex.error.BibFileSyntaxError-class.html#__init__,Method bkn.bibtex.error.FormatNotSupportedError.__init__()=bkn.bibtex.error.FormatNotSupportedError-class.html#__init__,Method bkn.bibtex.latex_converter.latex_converter.LatexConverter.__init__()=bkn.bibtex.latex_converter.latex_converter.LatexConverter-class.html#__init__,Method bkn.bibtex.latex_converter.latex_converter._LatexConverterDispatchProcessor.__init__()=bkn.bibtex.latex_converter.latex_converter._LatexConverterDispatchProcessor-class.html#__init__,Method bkn.bibtex.new_merge_tools.Fingerprint.__init__()=bkn.bibtex.new_merge_tools.Fingerprint-class.html#__init__,Method bkn.bibtex.utilities.Enumerate.__init__()=bkn.bibtex.utilities.Enumerate-class.html#__init__"><a title="bkn.bibtex.bibliography.BibEntry.__init__
bkn.bibtex.bibliography.Bibliography.__init__
bkn.bibtex.bibliography.Record.__init__
bkn.bibtex.bibliography._AddBibtexOutputEnchancer.__init__
bkn.bibtex.error.AttributeCollisionWarning.__init__
bkn.bibtex.error.BibFileSyntaxError.__init__
bkn.bibtex.error.FormatNotSupportedError.__init__
bkn.bibtex.latex_converter.latex_converter.LatexConverter.__init__
bkn.bibtex.latex_converter.latex_converter._LatexConverterDispatchProcessor.__init__
bkn.bibtex.new_merge_tools.Fingerprint.__init__
bkn.bibtex.utilities.Enumerate.__init__" class="py-name" href="#" onclick="return doclink('link-116', '__init__', 'link-116');">__init__</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">citekey</tt><tt class="py-op">,</tt> <tt class="py-name">bibtype</tt><tt class="py-op">,</tt> <tt class="py-name">fields</tt><tt class="py-op">)</tt> </tt>
<a name="L653"></a><tt class="py-lineno"> 653</tt>  <tt class="py-line">        <tt class="py-name">warnings</tt><tt class="py-op">.</tt><tt class="py-name">warn</tt><tt class="py-op">(</tt> </tt>
<a name="L654"></a><tt class="py-lineno"> 654</tt>  <tt class="py-line">            <tt class="py-string">"The BibEntry class has been deprecated. "</tt> <tt class="py-op">+</tt> </tt>
<a name="L655"></a><tt class="py-lineno"> 655</tt>  <tt class="py-line">            <tt class="py-string">"Please use the Record class instead."</tt><tt class="py-op">,</tt> </tt>
<a name="L656"></a><tt class="py-lineno"> 656</tt>  <tt class="py-line">            <tt class="py-name">DeprecationWarning</tt><tt class="py-op">,</tt> <tt class="py-name">stacklevel</tt><tt class="py-op">=</tt><tt class="py-number">2</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L657"></a><tt class="py-lineno"> 657</tt>  <tt class="py-line">         </tt>
<a name="Bibliography"></a><div id="Bibliography-def"><a name="L658"></a><tt class="py-lineno"> 658</tt>  <tt class="py-line">         </tt>
<a name="L659"></a><tt class="py-lineno"> 659</tt> <a class="py-toggle" href="#" id="Bibliography-toggle" onclick="return toggle('Bibliography');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="bkn.bibtex.bibliography.Bibliography-class.html">Bibliography</a><tt class="py-op">:</tt> </tt>
</div><div id="Bibliography-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="Bibliography-expanded"><a name="L660"></a><tt class="py-lineno"> 660</tt>  <tt class="py-line">    <tt class="py-docstring">'''A bibliography class with methods to load BibTeX data.'''</tt> </tt>
<a name="L661"></a><tt class="py-lineno"> 661</tt>  <tt class="py-line">     </tt>
<a name="L662"></a><tt class="py-lineno"> 662</tt>  <tt class="py-line">    <tt class="py-comment">#{ Methods for initializing Bibliography instances</tt> </tt>
<a name="L663"></a><tt class="py-lineno"> 663</tt>  <tt class="py-line">     </tt>
<a name="Bibliography.__init__"></a><div id="Bibliography.__init__-def"><a name="L664"></a><tt class="py-lineno"> 664</tt> <a class="py-toggle" href="#" id="Bibliography.__init__-toggle" onclick="return toggle('Bibliography.__init__');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography.Bibliography-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> </tt>
<a name="L665"></a><tt class="py-lineno"> 665</tt>  <tt class="py-line">                 <tt class="py-param">id</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt>
<a name="L666"></a><tt class="py-lineno"> 666</tt>  <tt class="py-line">                 <tt class="py-param">file</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt>
<a name="L667"></a><tt class="py-lineno"> 667</tt>  <tt class="py-line">                 <tt class="py-param">string</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt>
<a name="L668"></a><tt class="py-lineno"> 668</tt>  <tt class="py-line">                 <tt class="py-param">format</tt><tt class="py-op">=</tt><tt class="py-string">u'bibtex'</tt><tt class="py-op">,</tt> </tt>
<a name="L669"></a><tt class="py-lineno"> 669</tt>  <tt class="py-line">                 <tt class="py-param">dlist</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt>
<a name="L670"></a><tt class="py-lineno"> 670</tt>  <tt class="py-line">                 <tt class="py-param">preamble</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt>
<a name="L671"></a><tt class="py-lineno"> 671</tt>  <tt class="py-line">                 <tt class="py-param">metadata</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt>
<a name="L672"></a><tt class="py-lineno"> 672</tt>  <tt class="py-line">                 <tt class="py-param">entries</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Bibliography.__init__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Bibliography.__init__-expanded"><a name="L673"></a><tt class="py-lineno"> 673</tt>  <tt class="py-line">        <tt class="py-docstring">'''Initializes a new Bibliography instance.</tt> </tt>
<a name="L674"></a><tt class="py-lineno"> 674</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L675"></a><tt class="py-lineno"> 675</tt>  <tt class="py-line"><tt class="py-docstring">        To create an empty Bibliography:</tt> </tt>
<a name="L676"></a><tt class="py-lineno"> 676</tt>  <tt class="py-line"><tt class="py-docstring">       </tt> </tt>
<a name="L677"></a><tt class="py-lineno"> 677</tt>  <tt class="py-line"><tt class="py-docstring">            &gt;&gt;&gt; bib = Bibliography()</tt> </tt>
<a name="L678"></a><tt class="py-lineno"> 678</tt>  <tt class="py-line"><tt class="py-docstring">       </tt> </tt>
<a name="L679"></a><tt class="py-lineno"> 679</tt>  <tt class="py-line"><tt class="py-docstring">        To create a Bibliography from a file:</tt> </tt>
<a name="L680"></a><tt class="py-lineno"> 680</tt>  <tt class="py-line"><tt class="py-docstring">            </tt> </tt>
<a name="L681"></a><tt class="py-lineno"> 681</tt>  <tt class="py-line"><tt class="py-docstring">            &gt;&gt;&gt; bib = Bibliography(file='articles.bib')</tt> </tt>
<a name="L682"></a><tt class="py-lineno"> 682</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L683"></a><tt class="py-lineno"> 683</tt>  <tt class="py-line"><tt class="py-docstring">        or</tt> </tt>
<a name="L684"></a><tt class="py-lineno"> 684</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L685"></a><tt class="py-lineno"> 685</tt>  <tt class="py-line"><tt class="py-docstring">            &gt;&gt;&gt; file_handle = codecs.open('articles.bib', 'r', 'utf-8')</tt> </tt>
<a name="L686"></a><tt class="py-lineno"> 686</tt>  <tt class="py-line"><tt class="py-docstring">            &gt;&gt;&gt; bib = Bibliography(file=file_handle)</tt> </tt>
<a name="L687"></a><tt class="py-lineno"> 687</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L688"></a><tt class="py-lineno"> 688</tt>  <tt class="py-line"><tt class="py-docstring">        The file may be located on the web:</tt> </tt>
<a name="L689"></a><tt class="py-lineno"> 689</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L690"></a><tt class="py-lineno"> 690</tt>  <tt class="py-line"><tt class="py-docstring">            &gt;&gt;&gt; bib = Bibliography(file='example.org/books.bib')</tt> </tt>
<a name="L691"></a><tt class="py-lineno"> 691</tt>  <tt class="py-line"><tt class="py-docstring">            </tt> </tt>
<a name="L692"></a><tt class="py-lineno"> 692</tt>  <tt class="py-line"><tt class="py-docstring">        To create a Bibliography from a string:</tt> </tt>
<a name="L693"></a><tt class="py-lineno"> 693</tt>  <tt class="py-line"><tt class="py-docstring">            </tt> </tt>
<a name="L694"></a><tt class="py-lineno"> 694</tt>  <tt class="py-line"><tt class="py-docstring">            &gt;&gt;&gt; bibstring = """</tt> </tt>
<a name="L695"></a><tt class="py-lineno"> 695</tt>  <tt class="py-line"><tt class="py-docstring">            ... @article{spam,</tt> </tt>
<a name="L696"></a><tt class="py-lineno"> 696</tt>  <tt class="py-line"><tt class="py-docstring">            ...   title = {The Spanish Inquisition},</tt> </tt>
<a name="L697"></a><tt class="py-lineno"> 697</tt>  <tt class="py-line"><tt class="py-docstring">            ...   note = {Nobody expects it!}</tt> </tt>
<a name="L698"></a><tt class="py-lineno"> 698</tt>  <tt class="py-line"><tt class="py-docstring">            ... }"""</tt> </tt>
<a name="L699"></a><tt class="py-lineno"> 699</tt>  <tt class="py-line"><tt class="py-docstring">            &gt;&gt;&gt; bib = Bibliography(string=bibstring)</tt> </tt>
<a name="L700"></a><tt class="py-lineno"> 700</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L701"></a><tt class="py-lineno"> 701</tt>  <tt class="py-line"><tt class="py-docstring">        To create a Bibliography from a list of dictionaries:</tt> </tt>
<a name="L702"></a><tt class="py-lineno"> 702</tt>  <tt class="py-line"><tt class="py-docstring">            </tt> </tt>
<a name="L703"></a><tt class="py-lineno"> 703</tt>  <tt class="py-line"><tt class="py-docstring">            &gt;&gt;&gt; d_list = [{u'bibtype':u'article', </tt> </tt>
<a name="L704"></a><tt class="py-lineno"> 704</tt>  <tt class="py-line"><tt class="py-docstring">            ...            u'citekey':u'spam',</tt> </tt>
<a name="L705"></a><tt class="py-lineno"> 705</tt>  <tt class="py-line"><tt class="py-docstring">            ...            u'title':u'The Spanish Inquisition'}]</tt> </tt>
<a name="L706"></a><tt class="py-lineno"> 706</tt>  <tt class="py-line"><tt class="py-docstring">            &gt;&gt;&gt; bib = Bibliography(dlist = d_list)</tt> </tt>
<a name="L707"></a><tt class="py-lineno"> 707</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L708"></a><tt class="py-lineno"> 708</tt>  <tt class="py-line"><tt class="py-docstring">        @param id:</tt> </tt>
<a name="L709"></a><tt class="py-lineno"> 709</tt>  <tt class="py-line"><tt class="py-docstring">            an identifier for this bibliography. If this is not supplied</tt> </tt>
<a name="L710"></a><tt class="py-lineno"> 710</tt>  <tt class="py-line"><tt class="py-docstring">            an identifier will be generated in an arbitrary manor.</tt> </tt>
<a name="L711"></a><tt class="py-lineno"> 711</tt>  <tt class="py-line"><tt class="py-docstring">        @type id: str</tt> </tt>
<a name="L712"></a><tt class="py-lineno"> 712</tt>  <tt class="py-line"><tt class="py-docstring">        @param file:</tt> </tt>
<a name="L713"></a><tt class="py-lineno"> 713</tt>  <tt class="py-line"><tt class="py-docstring">            a File object or the location of a file containing a</tt> </tt>
<a name="L714"></a><tt class="py-lineno"> 714</tt>  <tt class="py-line"><tt class="py-docstring">            serialization from which this Bibliography should load records.</tt> </tt>
<a name="L715"></a><tt class="py-lineno"> 715</tt>  <tt class="py-line"><tt class="py-docstring">        @type file: str or File</tt> </tt>
<a name="L716"></a><tt class="py-lineno"> 716</tt>  <tt class="py-line"><tt class="py-docstring">        @param string:</tt> </tt>
<a name="L717"></a><tt class="py-lineno"> 717</tt>  <tt class="py-line"><tt class="py-docstring">            a serialization from which this Bibliography should load records.</tt> </tt>
<a name="L718"></a><tt class="py-lineno"> 718</tt>  <tt class="py-line"><tt class="py-docstring">        @type string: str</tt> </tt>
<a name="L719"></a><tt class="py-lineno"> 719</tt>  <tt class="py-line"><tt class="py-docstring">        @param format:</tt> </tt>
<a name="L720"></a><tt class="py-lineno"> 720</tt>  <tt class="py-line"><tt class="py-docstring">            the serialization format used by the supplied string or</tt> </tt>
<a name="L721"></a><tt class="py-lineno"> 721</tt>  <tt class="py-line"><tt class="py-docstring">            file. Allowed values are 'bibtex' or 'bibjson'.</tt> </tt>
<a name="L722"></a><tt class="py-lineno"> 722</tt>  <tt class="py-line"><tt class="py-docstring">        @type format: str</tt> </tt>
<a name="L723"></a><tt class="py-lineno"> 723</tt>  <tt class="py-line"><tt class="py-docstring">        @param dlist:</tt> </tt>
<a name="L724"></a><tt class="py-lineno"> 724</tt>  <tt class="py-line"><tt class="py-docstring">            a list of dictionaries from which this Bibliography should</tt> </tt>
<a name="L725"></a><tt class="py-lineno"> 725</tt>  <tt class="py-line"><tt class="py-docstring">            load records.</tt> </tt>
<a name="L726"></a><tt class="py-lineno"> 726</tt>  <tt class="py-line"><tt class="py-docstring">        @type dlist: list</tt> </tt>
<a name="L727"></a><tt class="py-lineno"> 727</tt>  <tt class="py-line"><tt class="py-docstring">        @param preamble:</tt> </tt>
<a name="L728"></a><tt class="py-lineno"> 728</tt>  <tt class="py-line"><tt class="py-docstring">            LaTeX code to be included in the preamble of this</tt> </tt>
<a name="L729"></a><tt class="py-lineno"> 729</tt>  <tt class="py-line"><tt class="py-docstring">            bibliography if it is serialized in BibTeX format. (The</tt> </tt>
<a name="L730"></a><tt class="py-lineno"> 730</tt>  <tt class="py-line"><tt class="py-docstring">            preamble will appear as an attribute of the dataset module</tt> </tt>
<a name="L731"></a><tt class="py-lineno"> 731</tt>  <tt class="py-line"><tt class="py-docstring">            when serializing to BibJSON.)</tt> </tt>
<a name="L732"></a><tt class="py-lineno"> 732</tt>  <tt class="py-line"><tt class="py-docstring">        @type preamble: str</tt> </tt>
<a name="L733"></a><tt class="py-lineno"> 733</tt>  <tt class="py-line"><tt class="py-docstring">        @param metadata:</tt> </tt>
<a name="L734"></a><tt class="py-lineno"> 734</tt>  <tt class="py-line"><tt class="py-docstring">             metadata for this Bibliography. This will be included in the</tt> </tt>
<a name="L735"></a><tt class="py-lineno"> 735</tt>  <tt class="py-line"><tt class="py-docstring">             dataset module when serializing BibJSON.</tt> </tt>
<a name="L736"></a><tt class="py-lineno"> 736</tt>  <tt class="py-line"><tt class="py-docstring">        @type metadata: dict</tt> </tt>
<a name="L737"></a><tt class="py-lineno"> 737</tt>  <tt class="py-line"><tt class="py-docstring">        @param entries: a list of Records to be added to this Bibliography.</tt> </tt>
<a name="L738"></a><tt class="py-lineno"> 738</tt>  <tt class="py-line"><tt class="py-docstring">        @type entries: list</tt> </tt>
<a name="L739"></a><tt class="py-lineno"> 739</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L740"></a><tt class="py-lineno"> 740</tt>  <tt class="py-line">        <tt id="link-117" class="py-name"><a title="bkn.bibtex.utilities.ensure_objects_are_unicode" class="py-name" href="#" onclick="return doclink('link-117', 'ensure_objects_are_unicode', 'link-8');">ensure_objects_are_unicode</a></tt><tt class="py-op">(</tt> </tt>
<a name="L741"></a><tt class="py-lineno"> 741</tt>  <tt class="py-line">            <tt class="py-name">id</tt><tt class="py-op">,</tt> <tt class="py-name">string</tt><tt class="py-op">,</tt> <tt class="py-name">dlist</tt><tt class="py-op">,</tt> <tt class="py-name">preamble</tt><tt class="py-op">,</tt> <tt class="py-name">metadata</tt><tt class="py-op">,</tt> <tt class="py-name">entries</tt><tt class="py-op">)</tt> </tt>
<a name="L742"></a><tt class="py-lineno"> 742</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">id_to_record_index</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L743"></a><tt class="py-lineno"> 743</tt>  <tt class="py-line">        <tt class="py-string">'''A dict mapping local ids to entries. Used for quick-lookup.</tt> </tt>
<a name="L744"></a><tt class="py-lineno"> 744</tt>  <tt class="py-line"><tt class="py-string">        </tt> </tt>
<a name="L745"></a><tt class="py-lineno"> 745</tt>  <tt class="py-line"><tt class="py-string">        @type: C{dict}'''</tt> </tt>
<a name="L746"></a><tt class="py-lineno"> 746</tt>  <tt class="py-line">         </tt>
<a name="L747"></a><tt class="py-lineno"> 747</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">record_list</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L748"></a><tt class="py-lineno"> 748</tt>  <tt class="py-line">        <tt class="py-string">'''A list of the BibEntries in this Bibliography instance.</tt> </tt>
<a name="L749"></a><tt class="py-lineno"> 749</tt>  <tt class="py-line"><tt class="py-string">        </tt> </tt>
<a name="L750"></a><tt class="py-lineno"> 750</tt>  <tt class="py-line"><tt class="py-string">        @type: C{list}</tt> </tt>
<a name="L751"></a><tt class="py-lineno"> 751</tt>  <tt class="py-line"><tt class="py-string">        '''</tt> </tt>
<a name="L752"></a><tt class="py-lineno"> 752</tt>  <tt class="py-line">         </tt>
<a name="L753"></a><tt class="py-lineno"> 753</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">metadata</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L754"></a><tt class="py-lineno"> 754</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">metadata</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L755"></a><tt class="py-lineno"> 755</tt>  <tt class="py-line">        <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L756"></a><tt class="py-lineno"> 756</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">metadata</tt> <tt class="py-op">=</tt> <tt class="py-name">metadata</tt> </tt>
<a name="L757"></a><tt class="py-lineno"> 757</tt>  <tt class="py-line">         </tt>
<a name="L758"></a><tt class="py-lineno"> 758</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">id</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L759"></a><tt class="py-lineno"> 759</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">metadata</tt><tt class="py-op">[</tt><tt class="py-string">u'id'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">unicode</tt><tt class="py-op">(</tt><tt class="py-name">repr</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt id="link-118" class="py-name"><a title="bkn.bibtex.bibliography.DEFAULT_ENCODING" class="py-name" href="#" onclick="return doclink('link-118', 'DEFAULT_ENCODING', 'link-48');">DEFAULT_ENCODING</a></tt><tt class="py-op">)</tt> </tt>
<a name="L760"></a><tt class="py-lineno"> 760</tt>  <tt class="py-line">        <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L761"></a><tt class="py-lineno"> 761</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">metadata</tt><tt class="py-op">[</tt><tt class="py-string">u'id'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">id</tt> </tt>
<a name="L762"></a><tt class="py-lineno"> 762</tt>  <tt class="py-line">         </tt>
<a name="L763"></a><tt class="py-lineno"> 763</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">preamble</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L764"></a><tt class="py-lineno"> 764</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">metadata</tt><tt class="py-op">[</tt><tt class="py-string">u'bibtex_preamble'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-string">u''</tt> </tt>
<a name="L765"></a><tt class="py-lineno"> 765</tt>  <tt class="py-line">        <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L766"></a><tt class="py-lineno"> 766</tt>  <tt class="py-line">           <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">metadata</tt><tt class="py-op">[</tt><tt class="py-string">u'bibtex_preamble'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">preamble</tt> </tt>
<a name="L767"></a><tt class="py-lineno"> 767</tt>  <tt class="py-line">         </tt>
<a name="L768"></a><tt class="py-lineno"> 768</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">entries</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L769"></a><tt class="py-lineno"> 769</tt>  <tt class="py-line">            <tt class="py-keyword">for</tt> <tt class="py-name">record</tt> <tt class="py-keyword">in</tt> <tt class="py-name">entries</tt><tt class="py-op">:</tt> </tt>
<a name="L770"></a><tt class="py-lineno"> 770</tt>  <tt class="py-line">                <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-119" class="py-name" targets="Method bkn.bibtex.bibliography.Bibliography.add_record()=bkn.bibtex.bibliography.Bibliography-class.html#add_record"><a title="bkn.bibtex.bibliography.Bibliography.add_record" class="py-name" href="#" onclick="return doclink('link-119', 'add_record', 'link-119');">add_record</a></tt><tt class="py-op">(</tt><tt class="py-name">record</tt><tt class="py-op">)</tt> </tt>
<a name="L771"></a><tt class="py-lineno"> 771</tt>  <tt class="py-line">         </tt>
<a name="L772"></a><tt class="py-lineno"> 772</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">file</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L773"></a><tt class="py-lineno"> 773</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-120" class="py-name" targets="Method bkn.bibtex.bibliography.Bibliography.load_from_file()=bkn.bibtex.bibliography.Bibliography-class.html#load_from_file"><a title="bkn.bibtex.bibliography.Bibliography.load_from_file" class="py-name" href="#" onclick="return doclink('link-120', 'load_from_file', 'link-120');">load_from_file</a></tt><tt class="py-op">(</tt><tt class="py-name">file</tt><tt class="py-op">,</tt> <tt class="py-name">format</tt><tt class="py-op">=</tt><tt class="py-name">format</tt><tt class="py-op">)</tt> </tt>
<a name="L774"></a><tt class="py-lineno"> 774</tt>  <tt class="py-line">         </tt>
<a name="L775"></a><tt class="py-lineno"> 775</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">string</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L776"></a><tt class="py-lineno"> 776</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-121" class="py-name" targets="Method bkn.bibtex.bibliography.Bibliography.load_from_string()=bkn.bibtex.bibliography.Bibliography-class.html#load_from_string"><a title="bkn.bibtex.bibliography.Bibliography.load_from_string" class="py-name" href="#" onclick="return doclink('link-121', 'load_from_string', 'link-121');">load_from_string</a></tt><tt class="py-op">(</tt><tt class="py-name">string</tt><tt class="py-op">,</tt> <tt class="py-name">format</tt><tt class="py-op">=</tt><tt class="py-name">format</tt><tt class="py-op">)</tt> </tt>
<a name="L777"></a><tt class="py-lineno"> 777</tt>  <tt class="py-line">         </tt>
<a name="L778"></a><tt class="py-lineno"> 778</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">dlist</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L779"></a><tt class="py-lineno"> 779</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-122" class="py-name" targets="Method bkn.bibtex.bibliography.Bibliography.load_from_dlist()=bkn.bibtex.bibliography.Bibliography-class.html#load_from_dlist"><a title="bkn.bibtex.bibliography.Bibliography.load_from_dlist" class="py-name" href="#" onclick="return doclink('link-122', 'load_from_dlist', 'link-122');">load_from_dlist</a></tt><tt class="py-op">(</tt><tt class="py-name">dlist</tt><tt class="py-op">)</tt> </tt>
<a name="L780"></a><tt class="py-lineno"> 780</tt>  <tt class="py-line">         </tt>
<a name="L781"></a><tt class="py-lineno"> 781</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">metadata</tt><tt class="py-op">[</tt><tt class="py-string">'id'</tt><tt class="py-op">]</tt> <tt class="py-keyword">in</tt> <tt id="link-123" class="py-name"><a title="bkn.bibtex.bibliography.bib_cache" class="py-name" href="#" onclick="return doclink('link-123', 'bib_cache', 'link-49');">bib_cache</a></tt><tt class="py-op">.</tt><tt class="py-name">keys</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L782"></a><tt class="py-lineno"> 782</tt>  <tt class="py-line">            <tt class="py-name">warnings</tt><tt class="py-op">.</tt><tt class="py-name">warn</tt><tt class="py-op">(</tt> </tt>
<a name="L783"></a><tt class="py-lineno"> 783</tt>  <tt class="py-line">                <tt id="link-124" class="py-name"><a title="bkn.bibtex.error.BKNBibtexWarning" class="py-name" href="#" onclick="return doclink('link-124', 'BKNBibtexWarning', 'link-26');">BKNBibtexWarning</a></tt><tt class="py-op">(</tt> </tt>
<a name="L784"></a><tt class="py-lineno"> 784</tt>  <tt class="py-line">                    <tt class="py-string">'A bibliography already exists with id '</tt> <tt class="py-op">+</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">metadata</tt><tt class="py-op">[</tt><tt class="py-string">'id'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L785"></a><tt class="py-lineno"> 785</tt>  <tt class="py-line">                <tt class="py-name">stacklevel</tt><tt class="py-op">=</tt><tt class="py-number">2</tt> </tt>
<a name="L786"></a><tt class="py-lineno"> 786</tt>  <tt class="py-line">                <tt class="py-op">)</tt> </tt>
<a name="L787"></a><tt class="py-lineno"> 787</tt>  <tt class="py-line">                <tt class="py-comment"># TO DO: subclass BKNBibtexWarning</tt> </tt>
<a name="L788"></a><tt class="py-lineno"> 788</tt>  <tt class="py-line">        <tt id="link-125" class="py-name"><a title="bkn.bibtex.bibliography.bib_cache" class="py-name" href="#" onclick="return doclink('link-125', 'bib_cache', 'link-49');">bib_cache</a></tt><tt class="py-op">[</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">metadata</tt><tt class="py-op">[</tt><tt class="py-string">'id'</tt><tt class="py-op">]</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt> </tt>
</div><a name="L789"></a><tt class="py-lineno"> 789</tt>  <tt class="py-line"> </tt>
<a name="Bibliography.load_from_file"></a><div id="Bibliography.load_from_file-def"><a name="L790"></a><tt class="py-lineno"> 790</tt> <a class="py-toggle" href="#" id="Bibliography.load_from_file-toggle" onclick="return toggle('Bibliography.load_from_file');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography.Bibliography-class.html#load_from_file">load_from_file</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">file</tt><tt class="py-op">,</tt> <tt class="py-param">format</tt><tt class="py-op">=</tt><tt class="py-string">'bibtex'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Bibliography.load_from_file-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Bibliography.load_from_file-expanded"><a name="L791"></a><tt class="py-lineno"> 791</tt>  <tt class="py-line">        <tt class="py-docstring">'''Loads bibliography entries from a file in the specified</tt> </tt>
<a name="L792"></a><tt class="py-lineno"> 792</tt>  <tt class="py-line"><tt class="py-docstring">        format.</tt> </tt>
<a name="L793"></a><tt class="py-lineno"> 793</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L794"></a><tt class="py-lineno"> 794</tt>  <tt class="py-line"><tt class="py-docstring">        Loaded BibEntries are appended to any BibEntries already in the</tt> </tt>
<a name="L795"></a><tt class="py-lineno"> 795</tt>  <tt class="py-line"><tt class="py-docstring">        Bibliography.</tt> </tt>
<a name="L796"></a><tt class="py-lineno"> 796</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L797"></a><tt class="py-lineno"> 797</tt>  <tt class="py-line"><tt class="py-docstring">        @param file:</tt> </tt>
<a name="L798"></a><tt class="py-lineno"> 798</tt>  <tt class="py-line"><tt class="py-docstring">            Specifies the file to use. May be a file object or a string.</tt> </tt>
<a name="L799"></a><tt class="py-lineno"> 799</tt>  <tt class="py-line"><tt class="py-docstring">            If a string is used, and it begins with 'http://' the file</tt> </tt>
<a name="L800"></a><tt class="py-lineno"> 800</tt>  <tt class="py-line"><tt class="py-docstring">            will be read from the web, otherwise a local file will be</tt> </tt>
<a name="L801"></a><tt class="py-lineno"> 801</tt>  <tt class="py-line"><tt class="py-docstring">            used.</tt> </tt>
<a name="L802"></a><tt class="py-lineno"> 802</tt>  <tt class="py-line"><tt class="py-docstring">        @type file:</tt> </tt>
<a name="L803"></a><tt class="py-lineno"> 803</tt>  <tt class="py-line"><tt class="py-docstring">            C{str} or C{File}</tt> </tt>
<a name="L804"></a><tt class="py-lineno"> 804</tt>  <tt class="py-line"><tt class="py-docstring">        @param format:</tt> </tt>
<a name="L805"></a><tt class="py-lineno"> 805</tt>  <tt class="py-line"><tt class="py-docstring">            The format in which the bibliographic data has been serialized.</tt> </tt>
<a name="L806"></a><tt class="py-lineno"> 806</tt>  <tt class="py-line"><tt class="py-docstring">        @type format:</tt> </tt>
<a name="L807"></a><tt class="py-lineno"> 807</tt>  <tt class="py-line"><tt class="py-docstring">            C{str}</tt> </tt>
<a name="L808"></a><tt class="py-lineno"> 808</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: C{None}</tt> </tt>
<a name="L809"></a><tt class="py-lineno"> 809</tt>  <tt class="py-line"><tt class="py-docstring">        @raises FormatNotSupportedError:</tt> </tt>
<a name="L810"></a><tt class="py-lineno"> 810</tt>  <tt class="py-line"><tt class="py-docstring">            A FormatNotSupportedError will be raised if the supplied format</tt> </tt>
<a name="L811"></a><tt class="py-lineno"> 811</tt>  <tt class="py-line"><tt class="py-docstring">            is not supported.</tt> </tt>
<a name="L812"></a><tt class="py-lineno"> 812</tt>  <tt class="py-line"><tt class="py-docstring">            </tt> </tt>
<a name="L813"></a><tt class="py-lineno"> 813</tt>  <tt class="py-line"><tt class="py-docstring">        @todo:</tt> </tt>
<a name="L814"></a><tt class="py-lineno"> 814</tt>  <tt class="py-line"><tt class="py-docstring">            consider revising this API. It may be better to do away with</tt> </tt>
<a name="L815"></a><tt class="py-lineno"> 815</tt>  <tt class="py-line"><tt class="py-docstring">            the format keyword and to use separate methods instead. </tt> </tt>
<a name="L816"></a><tt class="py-lineno"> 816</tt>  <tt class="py-line"><tt class="py-docstring">            Another possibility would be to make this and similar methods</tt> </tt>
<a name="L817"></a><tt class="py-lineno"> 817</tt>  <tt class="py-line"><tt class="py-docstring">            class methods which return a Bibliography object.</tt> </tt>
<a name="L818"></a><tt class="py-lineno"> 818</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L819"></a><tt class="py-lineno"> 819</tt>  <tt class="py-line">        <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L820"></a><tt class="py-lineno"> 820</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">file</tt><tt class="py-op">.</tt><tt class="py-name">startswith</tt><tt class="py-op">(</tt><tt class="py-string">u'http://'</tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> <tt class="py-name">file</tt><tt class="py-op">.</tt><tt class="py-name">startswith</tt><tt class="py-op">(</tt><tt class="py-string">u'file://'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L821"></a><tt class="py-lineno"> 821</tt>  <tt class="py-line">                <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">metadata</tt><tt class="py-op">[</tt><tt class="py-string">u'id'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">file</tt> <tt class="py-op">+</tt> <tt class="py-string">u'#'</tt> </tt>
<a name="L822"></a><tt class="py-lineno"> 822</tt>  <tt class="py-line">                <tt class="py-name">file</tt> <tt class="py-op">=</tt> <tt class="py-name">urllib</tt><tt class="py-op">.</tt><tt class="py-name">urlopen</tt><tt class="py-op">(</tt><tt class="py-name">file</tt><tt class="py-op">)</tt> </tt>
<a name="L823"></a><tt class="py-lineno"> 823</tt>  <tt class="py-line">            <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L824"></a><tt class="py-lineno"> 824</tt>  <tt class="py-line">                <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">metadata</tt><tt class="py-op">[</tt><tt class="py-string">u'id'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-string">u'file://'</tt> <tt class="py-op">+</tt> <tt class="py-name">file</tt> <tt class="py-op">+</tt> <tt class="py-string">u'#'</tt> </tt>
<a name="L825"></a><tt class="py-lineno"> 825</tt>  <tt class="py-line">        <tt class="py-keyword">except</tt> <tt class="py-name">AttributeError</tt><tt class="py-op">:</tt> </tt>
<a name="L826"></a><tt class="py-lineno"> 826</tt>  <tt class="py-line">           <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">metadata</tt><tt class="py-op">[</tt><tt class="py-string">u'id'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-string">u'file://'</tt> <tt class="py-op">+</tt> <tt class="py-name">file</tt><tt class="py-op">.</tt><tt class="py-name">name</tt>  <tt class="py-op">+</tt> <tt class="py-string">u'#'</tt> </tt>
<a name="L827"></a><tt class="py-lineno"> 827</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">format</tt> <tt class="py-op">==</tt> <tt class="py-string">u'bibtex'</tt><tt class="py-op">:</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-126" class="py-name" targets="Method bkn.bibtex.bibliography.Bibliography._load_from_bibtex_file()=bkn.bibtex.bibliography.Bibliography-class.html#_load_from_bibtex_file"><a title="bkn.bibtex.bibliography.Bibliography._load_from_bibtex_file" class="py-name" href="#" onclick="return doclink('link-126', '_load_from_bibtex_file', 'link-126');">_load_from_bibtex_file</a></tt><tt class="py-op">(</tt><tt class="py-name">file</tt><tt class="py-op">)</tt> </tt>
<a name="L828"></a><tt class="py-lineno"> 828</tt>  <tt class="py-line">        <tt class="py-keyword">elif</tt> <tt class="py-name">format</tt> <tt class="py-op">==</tt> <tt class="py-string">u'bibjson'</tt><tt class="py-op">:</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-127" class="py-name" targets="Method bkn.bibtex.bibliography.Bibliography._load_from_BibJSON_file()=bkn.bibtex.bibliography.Bibliography-class.html#_load_from_BibJSON_file"><a title="bkn.bibtex.bibliography.Bibliography._load_from_BibJSON_file" class="py-name" href="#" onclick="return doclink('link-127', '_load_from_BibJSON_file', 'link-127');">_load_from_BibJSON_file</a></tt><tt class="py-op">(</tt><tt class="py-name">file</tt><tt class="py-op">)</tt> </tt>
<a name="L829"></a><tt class="py-lineno"> 829</tt>  <tt class="py-line">        <tt class="py-keyword">else</tt><tt class="py-op">:</tt> <tt class="py-keyword">raise</tt> <tt id="link-128" class="py-name"><a title="bkn.bibtex.error.FormatNotSupportedError" class="py-name" href="#" onclick="return doclink('link-128', 'FormatNotSupportedError', 'link-29');">FormatNotSupportedError</a></tt><tt class="py-op">(</tt><tt class="py-name">format</tt><tt class="py-op">)</tt> </tt>
</div><a name="L830"></a><tt class="py-lineno"> 830</tt>  <tt class="py-line">     </tt>
<a name="Bibliography.load_from_string"></a><div id="Bibliography.load_from_string-def"><a name="L831"></a><tt class="py-lineno"> 831</tt> <a class="py-toggle" href="#" id="Bibliography.load_from_string-toggle" onclick="return toggle('Bibliography.load_from_string');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography.Bibliography-class.html#load_from_string">load_from_string</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">string</tt><tt class="py-op">,</tt> <tt class="py-param">format</tt><tt class="py-op">=</tt><tt class="py-string">'bibtex'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Bibliography.load_from_string-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Bibliography.load_from_string-expanded"><a name="L832"></a><tt class="py-lineno"> 832</tt>  <tt class="py-line">        <tt class="py-docstring">'''Loads bibliography entries from a string in the specified</tt> </tt>
<a name="L833"></a><tt class="py-lineno"> 833</tt>  <tt class="py-line"><tt class="py-docstring">        format.</tt> </tt>
<a name="L834"></a><tt class="py-lineno"> 834</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L835"></a><tt class="py-lineno"> 835</tt>  <tt class="py-line"><tt class="py-docstring">        Loaded BibEntries are appended to any BibEntries already in the</tt> </tt>
<a name="L836"></a><tt class="py-lineno"> 836</tt>  <tt class="py-line"><tt class="py-docstring">        Bibliography.</tt> </tt>
<a name="L837"></a><tt class="py-lineno"> 837</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L838"></a><tt class="py-lineno"> 838</tt>  <tt class="py-line"><tt class="py-docstring">        @param string:</tt> </tt>
<a name="L839"></a><tt class="py-lineno"> 839</tt>  <tt class="py-line"><tt class="py-docstring">            The string from which to load the records.</tt> </tt>
<a name="L840"></a><tt class="py-lineno"> 840</tt>  <tt class="py-line"><tt class="py-docstring">        @type string:</tt> </tt>
<a name="L841"></a><tt class="py-lineno"> 841</tt>  <tt class="py-line"><tt class="py-docstring">            C{str}</tt> </tt>
<a name="L842"></a><tt class="py-lineno"> 842</tt>  <tt class="py-line"><tt class="py-docstring">        @param format:</tt> </tt>
<a name="L843"></a><tt class="py-lineno"> 843</tt>  <tt class="py-line"><tt class="py-docstring">            The format in which the bibliographic data has been serialized.</tt> </tt>
<a name="L844"></a><tt class="py-lineno"> 844</tt>  <tt class="py-line"><tt class="py-docstring">        @type format:</tt> </tt>
<a name="L845"></a><tt class="py-lineno"> 845</tt>  <tt class="py-line"><tt class="py-docstring">            C{str}</tt> </tt>
<a name="L846"></a><tt class="py-lineno"> 846</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: C{None}</tt> </tt>
<a name="L847"></a><tt class="py-lineno"> 847</tt>  <tt class="py-line"><tt class="py-docstring">        @raises FormatNotSupportedError:</tt> </tt>
<a name="L848"></a><tt class="py-lineno"> 848</tt>  <tt class="py-line"><tt class="py-docstring">            A FormatNotSupportedError will be raised if the supplied format</tt> </tt>
<a name="L849"></a><tt class="py-lineno"> 849</tt>  <tt class="py-line"><tt class="py-docstring">            is not supported.</tt> </tt>
<a name="L850"></a><tt class="py-lineno"> 850</tt>  <tt class="py-line"><tt class="py-docstring">            </tt> </tt>
<a name="L851"></a><tt class="py-lineno"> 851</tt>  <tt class="py-line"><tt class="py-docstring">        @todo:</tt> </tt>
<a name="L852"></a><tt class="py-lineno"> 852</tt>  <tt class="py-line"><tt class="py-docstring">            consider revising this API. It may be better to do away with</tt> </tt>
<a name="L853"></a><tt class="py-lineno"> 853</tt>  <tt class="py-line"><tt class="py-docstring">            the format keyword and to use separate methods instead.</tt> </tt>
<a name="L854"></a><tt class="py-lineno"> 854</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L855"></a><tt class="py-lineno"> 855</tt>  <tt class="py-line">        <tt id="link-129" class="py-name"><a title="bkn.bibtex.utilities.ensure_objects_are_unicode" class="py-name" href="#" onclick="return doclink('link-129', 'ensure_objects_are_unicode', 'link-8');">ensure_objects_are_unicode</a></tt><tt class="py-op">(</tt><tt class="py-name">string</tt><tt class="py-op">)</tt> </tt>
<a name="L856"></a><tt class="py-lineno"> 856</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">format</tt> <tt class="py-op">==</tt> <tt class="py-string">'bibtex'</tt><tt class="py-op">:</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-130" class="py-name" targets="Method bkn.bibtex.bibliography.Bibliography._load_from_bibtex_string()=bkn.bibtex.bibliography.Bibliography-class.html#_load_from_bibtex_string"><a title="bkn.bibtex.bibliography.Bibliography._load_from_bibtex_string" class="py-name" href="#" onclick="return doclink('link-130', '_load_from_bibtex_string', 'link-130');">_load_from_bibtex_string</a></tt><tt class="py-op">(</tt><tt class="py-name">string</tt><tt class="py-op">)</tt> </tt>
<a name="L857"></a><tt class="py-lineno"> 857</tt>  <tt class="py-line">        <tt class="py-keyword">elif</tt> <tt class="py-name">format</tt> <tt class="py-op">==</tt> <tt class="py-string">'bibjson'</tt><tt class="py-op">:</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-131" class="py-name" targets="Method bkn.bibtex.bibliography.Bibliography._load_from_BibJSON_string()=bkn.bibtex.bibliography.Bibliography-class.html#_load_from_BibJSON_string"><a title="bkn.bibtex.bibliography.Bibliography._load_from_BibJSON_string" class="py-name" href="#" onclick="return doclink('link-131', '_load_from_BibJSON_string', 'link-131');">_load_from_BibJSON_string</a></tt><tt class="py-op">(</tt><tt class="py-name">string</tt><tt class="py-op">)</tt> </tt>
<a name="L858"></a><tt class="py-lineno"> 858</tt>  <tt class="py-line">        <tt class="py-keyword">else</tt><tt class="py-op">:</tt> <tt class="py-keyword">raise</tt> <tt id="link-132" class="py-name"><a title="bkn.bibtex.error.FormatNotSupportedError" class="py-name" href="#" onclick="return doclink('link-132', 'FormatNotSupportedError', 'link-29');">FormatNotSupportedError</a></tt><tt class="py-op">(</tt><tt class="py-name">format</tt><tt class="py-op">)</tt> </tt>
</div><a name="L859"></a><tt class="py-lineno"> 859</tt>  <tt class="py-line">              </tt>
<a name="Bibliography.load_from_dlist"></a><div id="Bibliography.load_from_dlist-def"><a name="L860"></a><tt class="py-lineno"> 860</tt> <a class="py-toggle" href="#" id="Bibliography.load_from_dlist-toggle" onclick="return toggle('Bibliography.load_from_dlist');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography.Bibliography-class.html#load_from_dlist">load_from_dlist</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">dlist</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Bibliography.load_from_dlist-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Bibliography.load_from_dlist-expanded"><a name="L861"></a><tt class="py-lineno"> 861</tt>  <tt class="py-line">        <tt class="py-docstring">'''Loads bibliography entries from a list of dictionaries.</tt> </tt>
<a name="L862"></a><tt class="py-lineno"> 862</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L863"></a><tt class="py-lineno"> 863</tt>  <tt class="py-line"><tt class="py-docstring">        This method will look for dictionaries of 'bibtype' and</tt> </tt>
<a name="L864"></a><tt class="py-lineno"> 864</tt>  <tt class="py-line"><tt class="py-docstring">        'citekey' to assign those parts of the entry. An error will be</tt> </tt>
<a name="L865"></a><tt class="py-lineno"> 865</tt>  <tt class="py-line"><tt class="py-docstring">        raised if either of these keys are missing.</tt> </tt>
<a name="L866"></a><tt class="py-lineno"> 866</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L867"></a><tt class="py-lineno"> 867</tt>  <tt class="py-line"><tt class="py-docstring">        Loaded BibEntries are appended to any BibEntries already in the</tt> </tt>
<a name="L868"></a><tt class="py-lineno"> 868</tt>  <tt class="py-line"><tt class="py-docstring">        Bibliography.</tt> </tt>
<a name="L869"></a><tt class="py-lineno"> 869</tt>  <tt class="py-line"><tt class="py-docstring">        @param dlist:</tt> </tt>
<a name="L870"></a><tt class="py-lineno"> 870</tt>  <tt class="py-line"><tt class="py-docstring">            a list of dictionaries, with each dictionary corresponding</tt> </tt>
<a name="L871"></a><tt class="py-lineno"> 871</tt>  <tt class="py-line"><tt class="py-docstring">            to a record.</tt> </tt>
<a name="L872"></a><tt class="py-lineno"> 872</tt>  <tt class="py-line"><tt class="py-docstring">        @type dlist: C{list} of C{dict}s</tt> </tt>
<a name="L873"></a><tt class="py-lineno"> 873</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: C{None}</tt> </tt>
<a name="L874"></a><tt class="py-lineno"> 874</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L875"></a><tt class="py-lineno"> 875</tt>  <tt class="py-line">        <tt class="py-keyword">for</tt> <tt class="py-name">dict</tt> <tt class="py-keyword">in</tt> <tt class="py-name">dlist</tt><tt class="py-op">:</tt> </tt>
<a name="L876"></a><tt class="py-lineno"> 876</tt>  <tt class="py-line">            <tt class="py-name">d</tt> <tt class="py-op">=</tt> <tt class="py-name">copy</tt><tt class="py-op">.</tt><tt class="py-name">deepcopy</tt><tt class="py-op">(</tt><tt class="py-name">dict</tt><tt class="py-op">)</tt> </tt>
<a name="L877"></a><tt class="py-lineno"> 877</tt>  <tt class="py-line">            <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L878"></a><tt class="py-lineno"> 878</tt>  <tt class="py-line">                <tt class="py-name">type</tt> <tt class="py-op">=</tt> <tt class="py-name">d</tt><tt class="py-op">[</tt><tt class="py-string">u'type'</tt><tt class="py-op">]</tt> </tt>
<a name="L879"></a><tt class="py-lineno"> 879</tt>  <tt class="py-line">            <tt class="py-keyword">except</tt> <tt class="py-name">KeyError</tt><tt class="py-op">:</tt> </tt>
<a name="L880"></a><tt class="py-lineno"> 880</tt>  <tt class="py-line">                <tt class="py-name">type</tt> <tt class="py-op">=</tt> <tt class="py-name">d</tt><tt class="py-op">[</tt><tt class="py-string">u'bibtype'</tt><tt class="py-op">]</tt> <tt class="py-comment"># obsolete but still supported</tt> </tt>
<a name="L881"></a><tt class="py-lineno"> 881</tt>  <tt class="py-line">                <tt class="py-keyword">del</tt> <tt class="py-name">d</tt><tt class="py-op">[</tt><tt class="py-string">u'bibtype'</tt><tt class="py-op">]</tt> </tt>
<a name="L882"></a><tt class="py-lineno"> 882</tt>  <tt class="py-line">            <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L883"></a><tt class="py-lineno"> 883</tt>  <tt class="py-line">                <tt class="py-name">id</tt> <tt class="py-op">=</tt> <tt class="py-name">d</tt><tt class="py-op">[</tt><tt class="py-string">u'id'</tt><tt class="py-op">]</tt> </tt>
<a name="L884"></a><tt class="py-lineno"> 884</tt>  <tt class="py-line">            <tt class="py-keyword">except</tt> <tt class="py-name">KeyError</tt><tt class="py-op">:</tt> </tt>
<a name="L885"></a><tt class="py-lineno"> 885</tt>  <tt class="py-line">                <tt class="py-name">id</tt> <tt class="py-op">=</tt> <tt class="py-name">d</tt><tt class="py-op">[</tt><tt class="py-string">u'citekey'</tt><tt class="py-op">]</tt> <tt class="py-comment"># obsolete but still supported</tt> </tt>
<a name="L886"></a><tt class="py-lineno"> 886</tt>  <tt class="py-line">                <tt class="py-keyword">del</tt> <tt class="py-name">d</tt><tt class="py-op">[</tt><tt class="py-string">u'citekey'</tt><tt class="py-op">]</tt> </tt>
<a name="L887"></a><tt class="py-lineno"> 887</tt>  <tt class="py-line">            <tt class="py-name">e</tt> <tt class="py-op">=</tt> <tt id="link-133" class="py-name"><a title="bkn.bibtex.bibliography.Record" class="py-name" href="#" onclick="return doclink('link-133', 'Record', 'link-62');">Record</a></tt><tt class="py-op">(</tt><tt class="py-name">bibtype</tt><tt class="py-op">=</tt><tt class="py-name">type</tt><tt class="py-op">,</tt> </tt>
<a name="L888"></a><tt class="py-lineno"> 888</tt>  <tt class="py-line">                <tt class="py-name">citekey</tt><tt class="py-op">=</tt><tt class="py-name">id</tt><tt class="py-op">,</tt> </tt>
<a name="L889"></a><tt class="py-lineno"> 889</tt>  <tt class="py-line">                <tt class="py-name">attribute_map</tt><tt class="py-op">=</tt><tt class="py-name">d</tt><tt class="py-op">)</tt> </tt>
<a name="L890"></a><tt class="py-lineno"> 890</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-134" class="py-name"><a title="bkn.bibtex.bibliography.Bibliography.add_record" class="py-name" href="#" onclick="return doclink('link-134', 'add_record', 'link-119');">add_record</a></tt><tt class="py-op">(</tt><tt class="py-name">e</tt><tt class="py-op">)</tt> </tt>
</div><a name="L891"></a><tt class="py-lineno"> 891</tt>  <tt class="py-line"> </tt>
<a name="Bibliography._load_from_bibtex_file"></a><div id="Bibliography._load_from_bibtex_file-def"><a name="L892"></a><tt class="py-lineno"> 892</tt> <a class="py-toggle" href="#" id="Bibliography._load_from_bibtex_file-toggle" onclick="return toggle('Bibliography._load_from_bibtex_file');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography.Bibliography-class.html#_load_from_bibtex_file">_load_from_bibtex_file</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">file</tt><tt class="py-op">,</tt> <tt class="py-param">encoding</tt><tt class="py-op">=</tt><tt class="py-string">'utf-8'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Bibliography._load_from_bibtex_file-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Bibliography._load_from_bibtex_file-expanded"><a name="L893"></a><tt class="py-lineno"> 893</tt>  <tt class="py-line">        <tt class="py-docstring">'''Loads records into this bibliography from the specified BibTeX file.</tt> </tt>
<a name="L894"></a><tt class="py-lineno"> 894</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L895"></a><tt class="py-lineno"> 895</tt>  <tt class="py-line"><tt class="py-docstring">        @param file: the path to the file or a file object.</tt> </tt>
<a name="L896"></a><tt class="py-lineno"> 896</tt>  <tt class="py-line"><tt class="py-docstring">        @type file: C{str}, C{unicode}, or C{file}</tt> </tt>
<a name="L897"></a><tt class="py-lineno"> 897</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: C{None}</tt> </tt>
<a name="L898"></a><tt class="py-lineno"> 898</tt>  <tt class="py-line"><tt class="py-docstring">        @raise ParserSyntaxError: if there is an error in the BibTeX file.</tt> </tt>
<a name="L899"></a><tt class="py-lineno"> 899</tt>  <tt class="py-line"><tt class="py-docstring">        @todo:</tt> </tt>
<a name="L900"></a><tt class="py-lineno"> 900</tt>  <tt class="py-line"><tt class="py-docstring">            the encoding keyword is not currently handled correctly if</tt> </tt>
<a name="L901"></a><tt class="py-lineno"> 901</tt>  <tt class="py-line"><tt class="py-docstring">            C{file} is a C{File} object (as opposed to a file name). It</tt> </tt>
<a name="L902"></a><tt class="py-lineno"> 902</tt>  <tt class="py-line"><tt class="py-docstring">            may be best to split these two approaches into distinct</tt> </tt>
<a name="L903"></a><tt class="py-lineno"> 903</tt>  <tt class="py-line"><tt class="py-docstring">            methods.</tt> </tt>
<a name="L904"></a><tt class="py-lineno"> 904</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L905"></a><tt class="py-lineno"> 905</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">file</tt><tt class="py-op">,</tt> <tt class="py-name">types</tt><tt class="py-op">.</tt><tt class="py-name">StringTypes</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L906"></a><tt class="py-lineno"> 906</tt>  <tt class="py-line">            <tt class="py-name">file</tt> <tt class="py-op">=</tt> <tt class="py-name">codecs</tt><tt class="py-op">.</tt><tt class="py-name">open</tt><tt class="py-op">(</tt><tt class="py-name">file</tt><tt class="py-op">,</tt> <tt class="py-string">'r'</tt><tt class="py-op">,</tt> <tt class="py-name">encoding</tt><tt class="py-op">)</tt> </tt>
<a name="L907"></a><tt class="py-lineno"> 907</tt>  <tt class="py-line">            <tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt class="py-name">file</tt><tt class="py-op">.</tt><tt class="py-name">read</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L908"></a><tt class="py-lineno"> 908</tt>  <tt class="py-line">        <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L909"></a><tt class="py-lineno"> 909</tt>  <tt class="py-line">            <tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt class="py-name">file</tt><tt class="py-op">.</tt><tt class="py-name">read</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">decode</tt><tt class="py-op">(</tt><tt class="py-name">encoding</tt><tt class="py-op">)</tt> </tt>
<a name="L910"></a><tt class="py-lineno"> 910</tt>  <tt class="py-line">        <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L911"></a><tt class="py-lineno"> 911</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-135" class="py-name"><a title="bkn.bibtex.bibliography.Bibliography._load_from_bibtex_string" class="py-name" href="#" onclick="return doclink('link-135', '_load_from_bibtex_string', 'link-130');">_load_from_bibtex_string</a></tt><tt class="py-op">(</tt><tt class="py-name">content</tt><tt class="py-op">)</tt> </tt>
<a name="L912"></a><tt class="py-lineno"> 912</tt>  <tt class="py-line">        <tt class="py-keyword">except</tt> <tt class="py-name">ParserSyntaxError</tt> <tt class="py-keyword">as</tt> <tt class="py-name">err</tt><tt class="py-op">:</tt> </tt>
<a name="L913"></a><tt class="py-lineno"> 913</tt>  <tt class="py-line">            <tt class="py-keyword">raise</tt> <tt id="link-136" class="py-name"><a title="bkn.bibtex.error.BibFileSyntaxError" class="py-name" href="#" onclick="return doclink('link-136', 'BibFileSyntaxError', 'link-17');">BibFileSyntaxError</a></tt><tt class="py-op">(</tt><tt class="py-name">err</tt><tt class="py-op">,</tt> <tt class="py-name">file</tt><tt class="py-op">.</tt><tt class="py-name">name</tt><tt class="py-op">)</tt> </tt>
</div><a name="L914"></a><tt class="py-lineno"> 914</tt>  <tt class="py-line">     </tt>
<a name="Bibliography._load_from_BibJSON_file"></a><div id="Bibliography._load_from_BibJSON_file-def"><a name="L915"></a><tt class="py-lineno"> 915</tt> <a class="py-toggle" href="#" id="Bibliography._load_from_BibJSON_file-toggle" onclick="return toggle('Bibliography._load_from_BibJSON_file');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography.Bibliography-class.html#_load_from_BibJSON_file">_load_from_BibJSON_file</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">file</tt><tt class="py-op">,</tt> <tt class="py-param">encoding</tt><tt class="py-op">=</tt><tt class="py-string">'utf-8'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Bibliography._load_from_BibJSON_file-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Bibliography._load_from_BibJSON_file-expanded"><a name="L916"></a><tt class="py-lineno"> 916</tt>  <tt class="py-line">        <tt class="py-docstring">'''Loads records into this bibliography from the specified BibJSON file.</tt> </tt>
<a name="L917"></a><tt class="py-lineno"> 917</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L918"></a><tt class="py-lineno"> 918</tt>  <tt class="py-line"><tt class="py-docstring">        @param file: the path to the file or a file object.</tt> </tt>
<a name="L919"></a><tt class="py-lineno"> 919</tt>  <tt class="py-line"><tt class="py-docstring">        @type file: C{str}, C{unicode}, or C{file}</tt> </tt>
<a name="L920"></a><tt class="py-lineno"> 920</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: C{None}</tt> </tt>
<a name="L921"></a><tt class="py-lineno"> 921</tt>  <tt class="py-line"><tt class="py-docstring">        @warning:</tt> </tt>
<a name="L922"></a><tt class="py-lineno"> 922</tt>  <tt class="py-line"><tt class="py-docstring">            This method uses the simpleparse module which does not support</tt> </tt>
<a name="L923"></a><tt class="py-lineno"> 923</tt>  <tt class="py-line"><tt class="py-docstring">            Unicode strings. For this reason strings passed to this method</tt> </tt>
<a name="L924"></a><tt class="py-lineno"> 924</tt>  <tt class="py-line"><tt class="py-docstring">            will be converted to the us-ascii encoding before being parsed.</tt> </tt>
<a name="L925"></a><tt class="py-lineno"> 925</tt>  <tt class="py-line"><tt class="py-docstring">        @todo:</tt> </tt>
<a name="L926"></a><tt class="py-lineno"> 926</tt>  <tt class="py-line"><tt class="py-docstring">            the encoding keyword is not currently handled correctly if</tt> </tt>
<a name="L927"></a><tt class="py-lineno"> 927</tt>  <tt class="py-line"><tt class="py-docstring">            C{file} is a C{File} object (as opposed to a file name). It</tt> </tt>
<a name="L928"></a><tt class="py-lineno"> 928</tt>  <tt class="py-line"><tt class="py-docstring">            may be best to split these two approaches into distinct</tt> </tt>
<a name="L929"></a><tt class="py-lineno"> 929</tt>  <tt class="py-line"><tt class="py-docstring">            methods.</tt> </tt>
<a name="L930"></a><tt class="py-lineno"> 930</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L931"></a><tt class="py-lineno"> 931</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">file</tt><tt class="py-op">,</tt> <tt class="py-name">types</tt><tt class="py-op">.</tt><tt class="py-name">StringTypes</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L932"></a><tt class="py-lineno"> 932</tt>  <tt class="py-line">            <tt class="py-name">file</tt> <tt class="py-op">=</tt> <tt class="py-name">codecs</tt><tt class="py-op">.</tt><tt class="py-name">open</tt><tt class="py-op">(</tt><tt class="py-name">file</tt><tt class="py-op">,</tt> <tt class="py-string">'r'</tt><tt class="py-op">,</tt> <tt class="py-name">encoding</tt><tt class="py-op">)</tt> </tt>
<a name="L933"></a><tt class="py-lineno"> 933</tt>  <tt class="py-line">            <tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt class="py-name">file</tt><tt class="py-op">.</tt><tt class="py-name">read</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L934"></a><tt class="py-lineno"> 934</tt>  <tt class="py-line">        <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L935"></a><tt class="py-lineno"> 935</tt>  <tt class="py-line">            <tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt class="py-name">file</tt><tt class="py-op">.</tt><tt class="py-name">read</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">decode</tt><tt class="py-op">(</tt><tt class="py-name">encoding</tt><tt class="py-op">)</tt> </tt>
<a name="L936"></a><tt class="py-lineno"> 936</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-137" class="py-name"><a title="bkn.bibtex.bibliography.Bibliography._load_from_BibJSON_string" class="py-name" href="#" onclick="return doclink('link-137', '_load_from_BibJSON_string', 'link-131');">_load_from_BibJSON_string</a></tt><tt class="py-op">(</tt><tt class="py-name">content</tt><tt class="py-op">)</tt> </tt>
</div><a name="L937"></a><tt class="py-lineno"> 937</tt>  <tt class="py-line">         </tt>
<a name="Bibliography._load_from_BibJSON_string"></a><div id="Bibliography._load_from_BibJSON_string-def"><a name="L938"></a><tt class="py-lineno"> 938</tt> <a class="py-toggle" href="#" id="Bibliography._load_from_BibJSON_string-toggle" onclick="return toggle('Bibliography._load_from_BibJSON_string');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography.Bibliography-class.html#_load_from_BibJSON_string">_load_from_BibJSON_string</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">string</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Bibliography._load_from_BibJSON_string-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Bibliography._load_from_BibJSON_string-expanded"><a name="L939"></a><tt class="py-lineno"> 939</tt>  <tt class="py-line">        <tt class="py-docstring">'''Loads records into this bibliography from a string in BibJSON format.</tt> </tt>
<a name="L940"></a><tt class="py-lineno"> 940</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L941"></a><tt class="py-lineno"> 941</tt>  <tt class="py-line"><tt class="py-docstring">        This method also updates the bibliography's metadata using the</tt> </tt>
<a name="L942"></a><tt class="py-lineno"> 942</tt>  <tt class="py-line"><tt class="py-docstring">        attributes of the supplied BibJSON's dataset module.</tt> </tt>
<a name="L943"></a><tt class="py-lineno"> 943</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L944"></a><tt class="py-lineno"> 944</tt>  <tt class="py-line"><tt class="py-docstring">        @param string: BibJSON data</tt> </tt>
<a name="L945"></a><tt class="py-lineno"> 945</tt>  <tt class="py-line"><tt class="py-docstring">        @type string: C{str}</tt> </tt>
<a name="L946"></a><tt class="py-lineno"> 946</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: C{None}</tt> </tt>
<a name="L947"></a><tt class="py-lineno"> 947</tt>  <tt class="py-line"><tt class="py-docstring">        @todo: add support for linkage?</tt> </tt>
<a name="L948"></a><tt class="py-lineno"> 948</tt>  <tt class="py-line"><tt class="py-docstring">        @todo: add support for schema?</tt> </tt>
<a name="L949"></a><tt class="py-lineno"> 949</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L950"></a><tt class="py-lineno"> 950</tt>  <tt class="py-line">        <tt id="link-138" class="py-name"><a title="bkn.bibtex.utilities.ensure_objects_are_unicode" class="py-name" href="#" onclick="return doclink('link-138', 'ensure_objects_are_unicode', 'link-8');">ensure_objects_are_unicode</a></tt><tt class="py-op">(</tt><tt class="py-name">string</tt><tt class="py-op">)</tt> </tt>
<a name="L951"></a><tt class="py-lineno"> 951</tt>  <tt class="py-line">        <tt class="py-name">bibJSONroot</tt> <tt class="py-op">=</tt> <tt class="py-name">json</tt><tt class="py-op">.</tt><tt class="py-name">loads</tt><tt class="py-op">(</tt><tt class="py-name">string</tt><tt class="py-op">)</tt> </tt>
<a name="L952"></a><tt class="py-lineno"> 952</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">metadata</tt><tt class="py-op">.</tt><tt class="py-name">update</tt><tt class="py-op">(</tt><tt class="py-name">bibJSONroot</tt><tt class="py-op">[</tt><tt class="py-string">'dataset'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L953"></a><tt class="py-lineno"> 953</tt>  <tt class="py-line">        <tt class="py-keyword">for</tt> <tt class="py-name">e</tt> <tt class="py-keyword">in</tt> <tt class="py-name">bibJSONroot</tt><tt class="py-op">[</tt><tt class="py-string">'recordList'</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
<a name="L954"></a><tt class="py-lineno"> 954</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-139" class="py-name"><a title="bkn.bibtex.bibliography.Bibliography.add_record" class="py-name" href="#" onclick="return doclink('link-139', 'add_record', 'link-119');">add_record</a></tt><tt class="py-op">(</tt><tt id="link-140" class="py-name"><a title="bkn.bibtex.bibliography.Record" class="py-name" href="#" onclick="return doclink('link-140', 'Record', 'link-62');">Record</a></tt><tt class="py-op">(</tt><tt class="py-name">attribute_map</tt><tt class="py-op">=</tt><tt class="py-name">e</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L955"></a><tt class="py-lineno"> 955</tt>  <tt class="py-line"> </tt>
<a name="Bibliography._load_from_bibtex_string"></a><div id="Bibliography._load_from_bibtex_string-def"><a name="L956"></a><tt class="py-lineno"> 956</tt> <a class="py-toggle" href="#" id="Bibliography._load_from_bibtex_string-toggle" onclick="return toggle('Bibliography._load_from_bibtex_string');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography.Bibliography-class.html#_load_from_bibtex_string">_load_from_bibtex_string</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">string</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Bibliography._load_from_bibtex_string-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Bibliography._load_from_bibtex_string-expanded"><a name="L957"></a><tt class="py-lineno"> 957</tt>  <tt class="py-line">        <tt class="py-docstring">'''Loads records into this bibliography from a string in BibTeX format.</tt> </tt>
<a name="L958"></a><tt class="py-lineno"> 958</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L959"></a><tt class="py-lineno"> 959</tt>  <tt class="py-line"><tt class="py-docstring">        @param string: BibTeX data</tt> </tt>
<a name="L960"></a><tt class="py-lineno"> 960</tt>  <tt class="py-line"><tt class="py-docstring">        @type string: C{str}</tt> </tt>
<a name="L961"></a><tt class="py-lineno"> 961</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: C{None}</tt> </tt>
<a name="L962"></a><tt class="py-lineno"> 962</tt>  <tt class="py-line"><tt class="py-docstring">        @warning:</tt> </tt>
<a name="L963"></a><tt class="py-lineno"> 963</tt>  <tt class="py-line"><tt class="py-docstring">            This method uses the simpleparse module which does not support</tt> </tt>
<a name="L964"></a><tt class="py-lineno"> 964</tt>  <tt class="py-line"><tt class="py-docstring">            Unicode strings. For this reason strings passed to this method</tt> </tt>
<a name="L965"></a><tt class="py-lineno"> 965</tt>  <tt class="py-line"><tt class="py-docstring">            will be converted to the us-ascii encoding before being parsed.</tt> </tt>
<a name="L966"></a><tt class="py-lineno"> 966</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L967"></a><tt class="py-lineno"> 967</tt>  <tt class="py-line">        <tt id="link-141" class="py-name"><a title="bkn.bibtex.utilities.ensure_objects_are_unicode" class="py-name" href="#" onclick="return doclink('link-141', 'ensure_objects_are_unicode', 'link-8');">ensure_objects_are_unicode</a></tt><tt class="py-op">(</tt><tt class="py-name">string</tt><tt class="py-op">)</tt> </tt>
<a name="L968"></a><tt class="py-lineno"> 968</tt>  <tt class="py-line">        <tt class="py-name">ascii_codec</tt> <tt class="py-op">=</tt> <tt class="py-name">codecs</tt><tt class="py-op">.</tt><tt class="py-name">lookup</tt><tt class="py-op">(</tt><tt class="py-string">'us-ascii'</tt><tt class="py-op">)</tt> </tt>
<a name="L969"></a><tt class="py-lineno"> 969</tt>  <tt class="py-line">        <tt class="py-op">(</tt><tt class="py-name">string</tt><tt class="py-op">,</tt> <tt class="py-name">_</tt><tt class="py-op">)</tt> <tt class="py-op">=</tt> <tt class="py-name">ascii_codec</tt><tt class="py-op">.</tt><tt class="py-name">encode</tt><tt class="py-op">(</tt><tt class="py-name">string</tt><tt class="py-op">,</tt> <tt class="py-string">'replace'</tt><tt class="py-op">)</tt> <tt class="py-comment"># second part of tuple is not needed</tt> </tt>
<a name="L970"></a><tt class="py-lineno"> 970</tt>  <tt class="py-line">        <tt class="py-name">result</tt> <tt class="py-op">=</tt> <tt class="py-name">BIBTEX_PARSER</tt><tt class="py-op">.</tt><tt class="py-name">parse</tt><tt class="py-op">(</tt><tt class="py-name">string</tt><tt class="py-op">,</tt> <tt class="py-name">processor</tt><tt class="py-op">=</tt><tt class="py-name">BibtexProcessor</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L971"></a><tt class="py-lineno"> 971</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">metadata</tt><tt class="py-op">[</tt><tt class="py-string">u'bibtex_preamble'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">unicode</tt><tt class="py-op">(</tt><tt class="py-name">result</tt><tt class="py-op">[</tt><tt class="py-string">'preamble'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt id="link-142" class="py-name"><a title="bkn.bibtex.bibliography.DEFAULT_ENCODING" class="py-name" href="#" onclick="return doclink('link-142', 'DEFAULT_ENCODING', 'link-48');">DEFAULT_ENCODING</a></tt><tt class="py-op">)</tt> </tt>
<a name="L972"></a><tt class="py-lineno"> 972</tt>  <tt class="py-line">        <tt class="py-keyword">for</tt> <tt class="py-name">e</tt> <tt class="py-keyword">in</tt> <tt class="py-name">result</tt><tt class="py-op">[</tt><tt class="py-string">'entries'</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
<a name="L973"></a><tt class="py-lineno"> 973</tt>  <tt class="py-line">            <tt class="py-op">(</tt><tt class="py-name">bibtype</tt><tt class="py-op">,</tt> <tt class="py-name">citekey</tt><tt class="py-op">,</tt> <tt class="py-name">fields</tt><tt class="py-op">)</tt> <tt class="py-op">=</tt> <tt class="py-name">e</tt> </tt>
<a name="L974"></a><tt class="py-lineno"> 974</tt>  <tt class="py-line">            <tt class="py-name">attribute_map</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L975"></a><tt class="py-lineno"> 975</tt>  <tt class="py-line">            <tt class="py-keyword">for</tt> <tt class="py-name">name</tt><tt class="py-op">,</tt> <tt class="py-name">value</tt> <tt class="py-keyword">in</tt> <tt class="py-name">fields</tt><tt class="py-op">.</tt><tt class="py-name">items</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L976"></a><tt class="py-lineno"> 976</tt>  <tt class="py-line">                <tt class="py-name">u_name</tt> <tt class="py-op">=</tt> <tt class="py-name">unicode</tt><tt class="py-op">(</tt><tt class="py-name">name</tt><tt class="py-op">,</tt> <tt id="link-143" class="py-name"><a title="bkn.bibtex.bibliography.DEFAULT_ENCODING" class="py-name" href="#" onclick="return doclink('link-143', 'DEFAULT_ENCODING', 'link-48');">DEFAULT_ENCODING</a></tt><tt class="py-op">)</tt> </tt>
<a name="L977"></a><tt class="py-lineno"> 977</tt>  <tt class="py-line">                <tt class="py-name">u_value</tt> <tt class="py-op">=</tt> <tt class="py-name">unicode</tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">,</tt> <tt id="link-144" class="py-name"><a title="bkn.bibtex.bibliography.DEFAULT_ENCODING" class="py-name" href="#" onclick="return doclink('link-144', 'DEFAULT_ENCODING', 'link-48');">DEFAULT_ENCODING</a></tt><tt class="py-op">)</tt> </tt>
<a name="L978"></a><tt class="py-lineno"> 978</tt>  <tt class="py-line">                <tt class="py-name">attribute_map</tt><tt class="py-op">[</tt><tt class="py-name">u_name</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">u_value</tt> </tt>
<a name="L979"></a><tt class="py-lineno"> 979</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-145" class="py-name"><a title="bkn.bibtex.bibliography.Bibliography.add_record" class="py-name" href="#" onclick="return doclink('link-145', 'add_record', 'link-119');">add_record</a></tt><tt class="py-op">(</tt> </tt>
<a name="L980"></a><tt class="py-lineno"> 980</tt>  <tt class="py-line">              <tt id="link-146" class="py-name"><a title="bkn.bibtex.bibliography.Record" class="py-name" href="#" onclick="return doclink('link-146', 'Record', 'link-62');">Record</a></tt><tt class="py-op">(</tt> </tt>
<a name="L981"></a><tt class="py-lineno"> 981</tt>  <tt class="py-line">                <tt class="py-name">bibtype</tt><tt class="py-op">=</tt><tt class="py-name">unicode</tt><tt class="py-op">(</tt><tt class="py-name">bibtype</tt><tt class="py-op">,</tt> <tt id="link-147" class="py-name"><a title="bkn.bibtex.bibliography.DEFAULT_ENCODING" class="py-name" href="#" onclick="return doclink('link-147', 'DEFAULT_ENCODING', 'link-48');">DEFAULT_ENCODING</a></tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L982"></a><tt class="py-lineno"> 982</tt>  <tt class="py-line">                <tt class="py-name">citekey</tt><tt class="py-op">=</tt><tt class="py-name">unicode</tt><tt class="py-op">(</tt><tt class="py-name">citekey</tt><tt class="py-op">,</tt> <tt id="link-148" class="py-name"><a title="bkn.bibtex.bibliography.DEFAULT_ENCODING" class="py-name" href="#" onclick="return doclink('link-148', 'DEFAULT_ENCODING', 'link-48');">DEFAULT_ENCODING</a></tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L983"></a><tt class="py-lineno"> 983</tt>  <tt class="py-line">                <tt class="py-name">attribute_map</tt><tt class="py-op">=</tt><tt class="py-name">attribute_map</tt> </tt>
<a name="L984"></a><tt class="py-lineno"> 984</tt>  <tt class="py-line">                <tt class="py-op">)</tt> </tt>
<a name="L985"></a><tt class="py-lineno"> 985</tt>  <tt class="py-line">              <tt class="py-op">)</tt> </tt>
</div><a name="L986"></a><tt class="py-lineno"> 986</tt>  <tt class="py-line">     </tt>
<a name="L987"></a><tt class="py-lineno"> 987</tt>  <tt class="py-line">    <tt class="py-comment">#{ Emulating contatiner type</tt> </tt>
<a name="Bibliography.__len__"></a><div id="Bibliography.__len__-def"><a name="L988"></a><tt class="py-lineno"> 988</tt> <a class="py-toggle" href="#" id="Bibliography.__len__-toggle" onclick="return toggle('Bibliography.__len__');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography.Bibliography-class.html#__len__">__len__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Bibliography.__len__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Bibliography.__len__-expanded"><a name="L989"></a><tt class="py-lineno"> 989</tt>  <tt class="py-line">        <tt class="py-docstring">'''Returns the number of records in this bibliography.</tt> </tt>
<a name="L990"></a><tt class="py-lineno"> 990</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L991"></a><tt class="py-lineno"> 991</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: C{int}</tt> </tt>
<a name="L992"></a><tt class="py-lineno"> 992</tt>  <tt class="py-line"><tt class="py-docstring">        @return: the number of records in this bibliography.</tt> </tt>
<a name="L993"></a><tt class="py-lineno"> 993</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L994"></a><tt class="py-lineno"> 994</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">record_list</tt><tt class="py-op">)</tt> </tt>
</div><a name="L995"></a><tt class="py-lineno"> 995</tt>  <tt class="py-line">     </tt>
<a name="Bibliography.__iter__"></a><div id="Bibliography.__iter__-def"><a name="L996"></a><tt class="py-lineno"> 996</tt> <a class="py-toggle" href="#" id="Bibliography.__iter__-toggle" onclick="return toggle('Bibliography.__iter__');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography.Bibliography-class.html#__iter__">__iter__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Bibliography.__iter__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Bibliography.__iter__-expanded"><a name="L997"></a><tt class="py-lineno"> 997</tt>  <tt class="py-line">        <tt class="py-docstring">'''Returns an iterator over this bibliography's records.</tt> </tt>
<a name="L998"></a><tt class="py-lineno"> 998</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L999"></a><tt class="py-lineno"> 999</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: C{iterator}</tt> </tt>
<a name="L1000"></a><tt class="py-lineno">1000</tt>  <tt class="py-line"><tt class="py-docstring">        @return: an iterator over this bibliography's records.</tt> </tt>
<a name="L1001"></a><tt class="py-lineno">1001</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L1002"></a><tt class="py-lineno">1002</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">record_list</tt><tt class="py-op">.</tt><tt id="link-149" class="py-name" targets="Method bkn.bibtex.bibliography.Bibliography.__iter__()=bkn.bibtex.bibliography.Bibliography-class.html#__iter__,Method bkn.bibtex.utilities.Enumerate.__iter__()=bkn.bibtex.utilities.Enumerate-class.html#__iter__"><a title="bkn.bibtex.bibliography.Bibliography.__iter__
bkn.bibtex.utilities.Enumerate.__iter__" class="py-name" href="#" onclick="return doclink('link-149', '__iter__', 'link-149');">__iter__</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1003"></a><tt class="py-lineno">1003</tt>  <tt class="py-line"> </tt>
<a name="Bibliography.sort"></a><div id="Bibliography.sort-def"><a name="L1004"></a><tt class="py-lineno">1004</tt> <a class="py-toggle" href="#" id="Bibliography.sort-toggle" onclick="return toggle('Bibliography.sort');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography.Bibliography-class.html#sort">sort</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">comparison</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Bibliography.sort-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Bibliography.sort-expanded"><a name="L1005"></a><tt class="py-lineno">1005</tt>  <tt class="py-line">        <tt class="py-docstring">'''Sort this bibliography, using the supplied comparison.</tt> </tt>
<a name="L1006"></a><tt class="py-lineno">1006</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L1007"></a><tt class="py-lineno">1007</tt>  <tt class="py-line"><tt class="py-docstring">        Some useful comparison functions can be found in the</tt> </tt>
<a name="L1008"></a><tt class="py-lineno">1008</tt>  <tt class="py-line"><tt class="py-docstring">        L{comparisons} module.</tt> </tt>
<a name="L1009"></a><tt class="py-lineno">1009</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L1010"></a><tt class="py-lineno">1010</tt>  <tt class="py-line"><tt class="py-docstring">             &gt;&gt;&gt; from bkn.bibtex.comparisons import compare_entries</tt> </tt>
<a name="L1011"></a><tt class="py-lineno">1011</tt>  <tt class="py-line"><tt class="py-docstring">             &gt;&gt;&gt; from bkn.bibtex.bibliography import Bibliography</tt> </tt>
<a name="L1012"></a><tt class="py-lineno">1012</tt>  <tt class="py-line"><tt class="py-docstring">             &gt;&gt;&gt; bib = Bibliography(file='dataset.bib')</tt> </tt>
<a name="L1013"></a><tt class="py-lineno">1013</tt>  <tt class="py-line"><tt class="py-docstring">             &gt;&gt;&gt; bib.sort(compare_entries)</tt> </tt>
<a name="L1014"></a><tt class="py-lineno">1014</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L1015"></a><tt class="py-lineno">1015</tt>  <tt class="py-line"><tt class="py-docstring">        @param comparison:</tt> </tt>
<a name="L1016"></a><tt class="py-lineno">1016</tt>  <tt class="py-line"><tt class="py-docstring">            a comparison function taking two arguments which should</tt> </tt>
<a name="L1017"></a><tt class="py-lineno">1017</tt>  <tt class="py-line"><tt class="py-docstring">            return a negative or positive number depending on whether</tt> </tt>
<a name="L1018"></a><tt class="py-lineno">1018</tt>  <tt class="py-line"><tt class="py-docstring">            the first argument should come before or after the second</tt> </tt>
<a name="L1019"></a><tt class="py-lineno">1019</tt>  <tt class="py-line"><tt class="py-docstring">            argument.</tt> </tt>
<a name="L1020"></a><tt class="py-lineno">1020</tt>  <tt class="py-line"><tt class="py-docstring">        @type comparison: C{function}</tt> </tt>
<a name="L1021"></a><tt class="py-lineno">1021</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: C{None}</tt> </tt>
<a name="L1022"></a><tt class="py-lineno">1022</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L1023"></a><tt class="py-lineno">1023</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">record_list</tt><tt class="py-op">.</tt><tt id="link-150" class="py-name"><a title="bkn.bibtex.bibliography.Bibliography.sort" class="py-name" href="#" onclick="return doclink('link-150', 'sort', 'link-75');">sort</a></tt><tt class="py-op">(</tt><tt class="py-name">comparison</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1024"></a><tt class="py-lineno">1024</tt>  <tt class="py-line">     </tt>
<a name="Bibliography.__getitem__"></a><div id="Bibliography.__getitem__-def"><a name="L1025"></a><tt class="py-lineno">1025</tt> <a class="py-toggle" href="#" id="Bibliography.__getitem__-toggle" onclick="return toggle('Bibliography.__getitem__');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography.Bibliography-class.html#__getitem__">__getitem__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">key</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Bibliography.__getitem__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Bibliography.__getitem__-expanded"><a name="L1026"></a><tt class="py-lineno">1026</tt>  <tt class="py-line">        <tt class="py-docstring">'''Allows you to access a record using bracket notation.</tt> </tt>
<a name="L1027"></a><tt class="py-lineno">1027</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L1028"></a><tt class="py-lineno">1028</tt>  <tt class="py-line"><tt class="py-docstring">            &gt;&gt;&gt; bib['id:23']</tt> </tt>
<a name="L1029"></a><tt class="py-lineno">1029</tt>  <tt class="py-line"><tt class="py-docstring">       </tt> </tt>
<a name="L1030"></a><tt class="py-lineno">1030</tt>  <tt class="py-line"><tt class="py-docstring">        C{key} may be either an integer, in which case it refers to the</tt> </tt>
<a name="L1031"></a><tt class="py-lineno">1031</tt>  <tt class="py-line"><tt class="py-docstring">        position of a record in the bibliography, or it may be a string,</tt> </tt>
<a name="L1032"></a><tt class="py-lineno">1032</tt>  <tt class="py-line"><tt class="py-docstring">        in which case it refers to the local id of the record to be</tt> </tt>
<a name="L1033"></a><tt class="py-lineno">1033</tt>  <tt class="py-line"><tt class="py-docstring">        retrieved.</tt> </tt>
<a name="L1034"></a><tt class="py-lineno">1034</tt>  <tt class="py-line"><tt class="py-docstring">       </tt> </tt>
<a name="L1035"></a><tt class="py-lineno">1035</tt>  <tt class="py-line"><tt class="py-docstring">        Note that while you may use the bracket notation to access records</tt> </tt>
<a name="L1036"></a><tt class="py-lineno">1036</tt>  <tt class="py-line"><tt class="py-docstring">        you may not set records this way, so:</tt> </tt>
<a name="L1037"></a><tt class="py-lineno">1037</tt>  <tt class="py-line"><tt class="py-docstring">           </tt> </tt>
<a name="L1038"></a><tt class="py-lineno">1038</tt>  <tt class="py-line"><tt class="py-docstring">            &gt;&gt;&gt; bib[0] = Record(record_data)</tt> </tt>
<a name="L1039"></a><tt class="py-lineno">1039</tt>  <tt class="py-line"><tt class="py-docstring">       </tt> </tt>
<a name="L1040"></a><tt class="py-lineno">1040</tt>  <tt class="py-line"><tt class="py-docstring">        will not work.</tt> </tt>
<a name="L1041"></a><tt class="py-lineno">1041</tt>  <tt class="py-line"><tt class="py-docstring">       </tt> </tt>
<a name="L1042"></a><tt class="py-lineno">1042</tt>  <tt class="py-line"><tt class="py-docstring">        @param key:</tt> </tt>
<a name="L1043"></a><tt class="py-lineno">1043</tt>  <tt class="py-line"><tt class="py-docstring">            either the position of the record to be retrieved or the</tt> </tt>
<a name="L1044"></a><tt class="py-lineno">1044</tt>  <tt class="py-line"><tt class="py-docstring">            local id of the record to be retrieved.</tt> </tt>
<a name="L1045"></a><tt class="py-lineno">1045</tt>  <tt class="py-line"><tt class="py-docstring">        @type key: C{int} or C{str}</tt> </tt>
<a name="L1046"></a><tt class="py-lineno">1046</tt>  <tt class="py-line"><tt class="py-docstring">        @return: the requested record</tt> </tt>
<a name="L1047"></a><tt class="py-lineno">1047</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: L{Record}</tt> </tt>
<a name="L1048"></a><tt class="py-lineno">1048</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L1049"></a><tt class="py-lineno">1049</tt>  <tt class="py-line">        <tt id="link-151" class="py-name"><a title="bkn.bibtex.utilities.ensure_objects_are_unicode" class="py-name" href="#" onclick="return doclink('link-151', 'ensure_objects_are_unicode', 'link-8');">ensure_objects_are_unicode</a></tt><tt class="py-op">(</tt><tt class="py-name">key</tt><tt class="py-op">)</tt> </tt>
<a name="L1050"></a><tt class="py-lineno">1050</tt>  <tt class="py-line">        <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L1051"></a><tt class="py-lineno">1051</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">record_list</tt><tt class="py-op">[</tt><tt class="py-name">key</tt><tt class="py-op">]</tt> </tt>
<a name="L1052"></a><tt class="py-lineno">1052</tt>  <tt class="py-line">        <tt class="py-keyword">except</tt> <tt class="py-name">TypeError</tt><tt class="py-op">:</tt> </tt>
<a name="L1053"></a><tt class="py-lineno">1053</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">id_to_record_index</tt><tt class="py-op">[</tt><tt class="py-name">key</tt><tt class="py-op">]</tt> </tt>
</div><a name="L1054"></a><tt class="py-lineno">1054</tt>  <tt class="py-line">     </tt>
<a name="Bibliography.append"></a><div id="Bibliography.append-def"><a name="L1055"></a><tt class="py-lineno">1055</tt> <a class="py-toggle" href="#" id="Bibliography.append-toggle" onclick="return toggle('Bibliography.append');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography.Bibliography-class.html#append">append</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">record</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Bibliography.append-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Bibliography.append-expanded"><a name="L1056"></a><tt class="py-lineno">1056</tt>  <tt class="py-line">        <tt class="py-docstring">'''A synomnym for add_record().</tt> </tt>
<a name="L1057"></a><tt class="py-lineno">1057</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L1058"></a><tt class="py-lineno">1058</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: L{Record}</tt> </tt>
<a name="L1059"></a><tt class="py-lineno">1059</tt>  <tt class="py-line"><tt class="py-docstring">        @see: L{add_record()}</tt> </tt>
<a name="L1060"></a><tt class="py-lineno">1060</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L1061"></a><tt class="py-lineno">1061</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-152" class="py-name"><a title="bkn.bibtex.bibliography.Bibliography.add_record" class="py-name" href="#" onclick="return doclink('link-152', 'add_record', 'link-119');">add_record</a></tt><tt class="py-op">(</tt><tt class="py-name">record</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1062"></a><tt class="py-lineno">1062</tt>  <tt class="py-line">     </tt>
<a name="Bibliography.remove"></a><div id="Bibliography.remove-def"><a name="L1063"></a><tt class="py-lineno">1063</tt> <a class="py-toggle" href="#" id="Bibliography.remove-toggle" onclick="return toggle('Bibliography.remove');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography.Bibliography-class.html#remove">remove</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">record</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Bibliography.remove-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Bibliography.remove-expanded"><a name="L1064"></a><tt class="py-lineno">1064</tt>  <tt class="py-line">        <tt class="py-docstring">'''A synonym for remove_record().</tt> </tt>
<a name="L1065"></a><tt class="py-lineno">1065</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L1066"></a><tt class="py-lineno">1066</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: C{None}</tt> </tt>
<a name="L1067"></a><tt class="py-lineno">1067</tt>  <tt class="py-line"><tt class="py-docstring">        @raises RecordNotFoundError:</tt> </tt>
<a name="L1068"></a><tt class="py-lineno">1068</tt>  <tt class="py-line"><tt class="py-docstring">            if the specified record cannot be found in this Bibliography.</tt> </tt>
<a name="L1069"></a><tt class="py-lineno">1069</tt>  <tt class="py-line"><tt class="py-docstring">        @see: L{remove_record}</tt> </tt>
<a name="L1070"></a><tt class="py-lineno">1070</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L1071"></a><tt class="py-lineno">1071</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-153" class="py-name" targets="Method bkn.bibtex.bibliography.Bibliography.remove_record()=bkn.bibtex.bibliography.Bibliography-class.html#remove_record"><a title="bkn.bibtex.bibliography.Bibliography.remove_record" class="py-name" href="#" onclick="return doclink('link-153', 'remove_record', 'link-153');">remove_record</a></tt><tt class="py-op">(</tt><tt class="py-name">record</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1072"></a><tt class="py-lineno">1072</tt>  <tt class="py-line">     </tt>
<a name="Bibliography.add_record"></a><div id="Bibliography.add_record-def"><a name="L1073"></a><tt class="py-lineno">1073</tt> <a class="py-toggle" href="#" id="Bibliography.add_record-toggle" onclick="return toggle('Bibliography.add_record');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography.Bibliography-class.html#add_record">add_record</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">record</tt><tt class="py-op">,</tt> <tt class="py-param">id</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Bibliography.add_record-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Bibliography.add_record-expanded"><a name="L1074"></a><tt class="py-lineno">1074</tt>  <tt class="py-line">        <tt class="py-docstring">'''Adds a copy of the supplied Record to this bibliography.</tt> </tt>
<a name="L1075"></a><tt class="py-lineno">1075</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L1076"></a><tt class="py-lineno">1076</tt>  <tt class="py-line"><tt class="py-docstring">        If the keyword paramater C{id} is supplied it will be used as</tt> </tt>
<a name="L1077"></a><tt class="py-lineno">1077</tt>  <tt class="py-line"><tt class="py-docstring">        the local id for the new record. The original record is left</tt> </tt>
<a name="L1078"></a><tt class="py-lineno">1078</tt>  <tt class="py-line"><tt class="py-docstring">        unchanged.</tt> </tt>
<a name="L1079"></a><tt class="py-lineno">1079</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L1080"></a><tt class="py-lineno">1080</tt>  <tt class="py-line"><tt class="py-docstring">        @param record: the Record to add</tt> </tt>
<a name="L1081"></a><tt class="py-lineno">1081</tt>  <tt class="py-line"><tt class="py-docstring">        @type record: L{Record}</tt> </tt>
<a name="L1082"></a><tt class="py-lineno">1082</tt>  <tt class="py-line"><tt class="py-docstring">        @return: the new Record</tt> </tt>
<a name="L1083"></a><tt class="py-lineno">1083</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: L{Record}</tt> </tt>
<a name="L1084"></a><tt class="py-lineno">1084</tt>  <tt class="py-line"><tt class="py-docstring">        @note:</tt> </tt>
<a name="L1085"></a><tt class="py-lineno">1085</tt>  <tt class="py-line"><tt class="py-docstring">            It is important to remember that a the supplied Record will</tt> </tt>
<a name="L1086"></a><tt class="py-lineno">1086</tt>  <tt class="py-line"><tt class="py-docstring">            not be added to the Bibliography; a copy of the Record will</tt> </tt>
<a name="L1087"></a><tt class="py-lineno">1087</tt>  <tt class="py-line"><tt class="py-docstring">            be added instead. This is necessary because a given Record</tt> </tt>
<a name="L1088"></a><tt class="py-lineno">1088</tt>  <tt class="py-line"><tt class="py-docstring">            can be a member of one and only one Bibliography.</tt> </tt>
<a name="L1089"></a><tt class="py-lineno">1089</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L1090"></a><tt class="py-lineno">1090</tt>  <tt class="py-line">        <tt class="py-name">record_copy</tt> <tt class="py-op">=</tt> <tt class="py-name">copy</tt><tt class="py-op">.</tt><tt class="py-name">deepcopy</tt><tt class="py-op">(</tt><tt class="py-name">record</tt><tt class="py-op">)</tt> </tt>
<a name="L1091"></a><tt class="py-lineno">1091</tt>  <tt class="py-line">        <tt class="py-name">record_copy</tt><tt class="py-op">.</tt><tt id="link-154" class="py-name"><a title="bkn.bibtex.bibliography.Record.set_parent_bib" class="py-name" href="#" onclick="return doclink('link-154', 'set_parent_bib', 'link-99');">set_parent_bib</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">)</tt> </tt>
<a name="L1092"></a><tt class="py-lineno">1092</tt>  <tt class="py-line"> </tt>
<a name="L1093"></a><tt class="py-lineno">1093</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">id</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L1094"></a><tt class="py-lineno">1094</tt>  <tt class="py-line">            <tt class="py-name">record_copy</tt><tt class="py-op">[</tt><tt class="py-string">u'id'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">id</tt> </tt>
<a name="L1095"></a><tt class="py-lineno">1095</tt>  <tt class="py-line">             </tt>
<a name="L1096"></a><tt class="py-lineno">1096</tt>  <tt class="py-line">        <tt class="py-comment"># check for duplicate id</tt> </tt>
<a name="L1097"></a><tt class="py-lineno">1097</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">record_copy</tt><tt class="py-op">[</tt><tt class="py-string">u'id'</tt><tt class="py-op">]</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">id_to_record_index</tt><tt class="py-op">.</tt><tt class="py-name">keys</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1098"></a><tt class="py-lineno">1098</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">record_copy</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">id_to_record_index</tt><tt class="py-op">[</tt><tt class="py-name">record_copy</tt><tt class="py-op">[</tt><tt class="py-string">u'id'</tt><tt class="py-op">]</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
<a name="L1099"></a><tt class="py-lineno">1099</tt>  <tt class="py-line">                <tt class="py-keyword">raise</tt> <tt id="link-155" class="py-name"><a title="bkn.bibtex.error.BKNBibtexError" class="py-name" href="#" onclick="return doclink('link-155', 'BKNBibtexError', 'link-23');">BKNBibtexError</a></tt><tt class="py-op">(</tt> </tt>
<a name="L1100"></a><tt class="py-lineno">1100</tt>  <tt class="py-line">                    <tt class="py-string">'A record with id '</tt> <tt class="py-op">+</tt> <tt class="py-name">repr</tt><tt class="py-op">(</tt><tt class="py-name">record_copy</tt><tt class="py-op">[</tt><tt class="py-string">u'id'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> <tt class="py-op">+</tt> </tt>
<a name="L1101"></a><tt class="py-lineno">1101</tt>  <tt class="py-line">                    <tt class="py-string">' already exists!'</tt><tt class="py-op">)</tt> </tt>
<a name="L1102"></a><tt class="py-lineno">1102</tt>  <tt class="py-line">                <tt class="py-comment"># should subclass BKNBibtexError</tt> </tt>
<a name="L1103"></a><tt class="py-lineno">1103</tt>  <tt class="py-line">         </tt>
<a name="L1104"></a><tt class="py-lineno">1104</tt>  <tt class="py-line">        <tt class="py-comment"># validate record</tt> </tt>
<a name="L1105"></a><tt class="py-lineno">1105</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-156" class="py-name"><a title="bkn.bibtex.bibliography.Bibliography.validate_record" class="py-name" href="#" onclick="return doclink('link-156', 'validate_record', 'link-112');">validate_record</a></tt><tt class="py-op">(</tt><tt class="py-name">record_copy</tt><tt class="py-op">)</tt> </tt>
<a name="L1106"></a><tt class="py-lineno">1106</tt>  <tt class="py-line">         </tt>
<a name="L1107"></a><tt class="py-lineno">1107</tt>  <tt class="py-line">        <tt class="py-comment"># add to index</tt> </tt>
<a name="L1108"></a><tt class="py-lineno">1108</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">id_to_record_index</tt><tt class="py-op">[</tt><tt class="py-name">record_copy</tt><tt class="py-op">[</tt><tt class="py-string">u'id'</tt><tt class="py-op">]</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">record_copy</tt> </tt>
<a name="L1109"></a><tt class="py-lineno">1109</tt>  <tt class="py-line">         </tt>
<a name="L1110"></a><tt class="py-lineno">1110</tt>  <tt class="py-line">        <tt class="py-comment"># add to this bib</tt> </tt>
<a name="L1111"></a><tt class="py-lineno">1111</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">record_list</tt><tt class="py-op">.</tt><tt id="link-157" class="py-name" targets="Method bkn.bibtex.bibliography.Bibliography.append()=bkn.bibtex.bibliography.Bibliography-class.html#append"><a title="bkn.bibtex.bibliography.Bibliography.append" class="py-name" href="#" onclick="return doclink('link-157', 'append', 'link-157');">append</a></tt><tt class="py-op">(</tt><tt class="py-name">record_copy</tt><tt class="py-op">)</tt> </tt>
<a name="L1112"></a><tt class="py-lineno">1112</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">record_copy</tt> </tt>
</div><a name="L1113"></a><tt class="py-lineno">1113</tt>  <tt class="py-line">     </tt>
<a name="Bibliography.remove_record"></a><div id="Bibliography.remove_record-def"><a name="L1114"></a><tt class="py-lineno">1114</tt> <a class="py-toggle" href="#" id="Bibliography.remove_record-toggle" onclick="return toggle('Bibliography.remove_record');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography.Bibliography-class.html#remove_record">remove_record</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">record</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Bibliography.remove_record-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Bibliography.remove_record-expanded"><a name="L1115"></a><tt class="py-lineno">1115</tt>  <tt class="py-line">        <tt class="py-docstring">'''Removes the supplied Record from the bibliography.</tt> </tt>
<a name="L1116"></a><tt class="py-lineno">1116</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L1117"></a><tt class="py-lineno">1117</tt>  <tt class="py-line"><tt class="py-docstring">        @param record: the record to be removed</tt> </tt>
<a name="L1118"></a><tt class="py-lineno">1118</tt>  <tt class="py-line"><tt class="py-docstring">        @type record: Record</tt> </tt>
<a name="L1119"></a><tt class="py-lineno">1119</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: C{None}</tt> </tt>
<a name="L1120"></a><tt class="py-lineno">1120</tt>  <tt class="py-line"><tt class="py-docstring">        @raises RecordNotFoundError:</tt> </tt>
<a name="L1121"></a><tt class="py-lineno">1121</tt>  <tt class="py-line"><tt class="py-docstring">            if the specified record cannot be found in this Bibliography.</tt> </tt>
<a name="L1122"></a><tt class="py-lineno">1122</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L1123"></a><tt class="py-lineno">1123</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">record</tt><tt class="py-op">.</tt><tt id="link-158" class="py-name" targets="Method bkn.bibtex.bibliography.Record.get_parent_bib()=bkn.bibtex.bibliography.Record-class.html#get_parent_bib"><a title="bkn.bibtex.bibliography.Record.get_parent_bib" class="py-name" href="#" onclick="return doclink('link-158', 'get_parent_bib', 'link-158');">get_parent_bib</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-op">!=</tt> <tt class="py-name">self</tt><tt class="py-op">:</tt> </tt>
<a name="L1124"></a><tt class="py-lineno">1124</tt>  <tt class="py-line">            <tt class="py-keyword">raise</tt> <tt id="link-159" class="py-name"><a title="bkn.bibtex.error.RecordNotFoundError" class="py-name" href="#" onclick="return doclink('link-159', 'RecordNotFoundError', 'link-41');">RecordNotFoundError</a></tt><tt class="py-op">(</tt><tt class="py-string">'Record to be removed is not in this bibliography.'</tt><tt class="py-op">)</tt> </tt>
<a name="L1125"></a><tt class="py-lineno">1125</tt>  <tt class="py-line">         </tt>
<a name="L1126"></a><tt class="py-lineno">1126</tt>  <tt class="py-line">        <tt class="py-keyword">del</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">id_to_record_index</tt><tt class="py-op">[</tt><tt class="py-name">record</tt><tt class="py-op">[</tt><tt class="py-string">u'id'</tt><tt class="py-op">]</tt><tt class="py-op">]</tt> </tt>
<a name="L1127"></a><tt class="py-lineno">1127</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">record_list</tt><tt class="py-op">.</tt><tt id="link-160" class="py-name" targets="Method bkn.bibtex.bibliography.Bibliography.remove()=bkn.bibtex.bibliography.Bibliography-class.html#remove"><a title="bkn.bibtex.bibliography.Bibliography.remove" class="py-name" href="#" onclick="return doclink('link-160', 'remove', 'link-160');">remove</a></tt><tt class="py-op">(</tt><tt class="py-name">record</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1128"></a><tt class="py-lineno">1128</tt>  <tt class="py-line">     </tt>
<a name="L1129"></a><tt class="py-lineno">1129</tt>  <tt class="py-line">    <tt class="py-comment">#{ Methods for working with record ids and references</tt> </tt>
<a name="L1130"></a><tt class="py-lineno">1130</tt>  <tt class="py-line">     </tt>
<a name="Bibliography.assign_numerical_ids"></a><div id="Bibliography.assign_numerical_ids-def"><a name="L1131"></a><tt class="py-lineno">1131</tt> <a class="py-toggle" href="#" id="Bibliography.assign_numerical_ids-toggle" onclick="return toggle('Bibliography.assign_numerical_ids');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography.Bibliography-class.html#assign_numerical_ids">assign_numerical_ids</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Bibliography.assign_numerical_ids-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Bibliography.assign_numerical_ids-expanded"><a name="L1132"></a><tt class="py-lineno">1132</tt>  <tt class="py-line">        <tt class="py-docstring">'''Assigns sequention numerical local ids to each record in this bibliography.'''</tt> </tt>
<a name="L1133"></a><tt class="py-lineno">1133</tt>  <tt class="py-line">        <tt class="py-comment"># we must first assign non-numerics ids in order to avoid conflicts</tt> </tt>
<a name="L1134"></a><tt class="py-lineno">1134</tt>  <tt class="py-line">        <tt class="py-keyword">for</tt> <tt class="py-name">i</tt> <tt class="py-keyword">in</tt> <tt class="py-name">range</tt><tt class="py-op">(</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">record_list</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1135"></a><tt class="py-lineno">1135</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">record_list</tt><tt class="py-op">[</tt><tt class="py-name">i</tt><tt class="py-op">]</tt><tt class="py-op">[</tt><tt class="py-string">u'id'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-161" class="py-name" targets="Method bkn.bibtex.bibliography.Bibliography.get_unique_id()=bkn.bibtex.bibliography.Bibliography-class.html#get_unique_id"><a title="bkn.bibtex.bibliography.Bibliography.get_unique_id" class="py-name" href="#" onclick="return doclink('link-161', 'get_unique_id', 'link-161');">get_unique_id</a></tt><tt class="py-op">(</tt><tt class="py-name">prefix</tt><tt class="py-op">=</tt><tt class="py-string">'tmp'</tt><tt class="py-op">)</tt> </tt>
<a name="L1136"></a><tt class="py-lineno">1136</tt>  <tt class="py-line">        <tt class="py-keyword">for</tt> <tt class="py-name">i</tt> <tt class="py-keyword">in</tt> <tt class="py-name">range</tt><tt class="py-op">(</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">record_list</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1137"></a><tt class="py-lineno">1137</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">record_list</tt><tt class="py-op">[</tt><tt class="py-name">i</tt><tt class="py-op">]</tt><tt class="py-op">[</tt><tt class="py-string">u'id'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">unicode</tt><tt class="py-op">(</tt><tt class="py-name">i</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1138"></a><tt class="py-lineno">1138</tt>  <tt class="py-line"> </tt>
<a name="Bibliography.record_from_id"></a><div id="Bibliography.record_from_id-def"><a name="L1139"></a><tt class="py-lineno">1139</tt> <a class="py-toggle" href="#" id="Bibliography.record_from_id-toggle" onclick="return toggle('Bibliography.record_from_id');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography.Bibliography-class.html#record_from_id">record_from_id</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">local_id</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Bibliography.record_from_id-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Bibliography.record_from_id-expanded"><a name="L1140"></a><tt class="py-lineno">1140</tt>  <tt class="py-line">        <tt class="py-docstring">'''Returns the Record with the given local id.</tt> </tt>
<a name="L1141"></a><tt class="py-lineno">1141</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L1142"></a><tt class="py-lineno">1142</tt>  <tt class="py-line"><tt class="py-docstring">        @param local_id: the local id of a record in this bibliography.</tt> </tt>
<a name="L1143"></a><tt class="py-lineno">1143</tt>  <tt class="py-line"><tt class="py-docstring">        @type local_id: str</tt> </tt>
<a name="L1144"></a><tt class="py-lineno">1144</tt>  <tt class="py-line"><tt class="py-docstring">        @return: the Record with the given local id</tt> </tt>
<a name="L1145"></a><tt class="py-lineno">1145</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: L{Record}</tt> </tt>
<a name="L1146"></a><tt class="py-lineno">1146</tt>  <tt class="py-line"><tt class="py-docstring">        @raises RecordNotFoundError:</tt> </tt>
<a name="L1147"></a><tt class="py-lineno">1147</tt>  <tt class="py-line"><tt class="py-docstring">            if no Record in this Bibliography has the specified local id.</tt> </tt>
<a name="L1148"></a><tt class="py-lineno">1148</tt>  <tt class="py-line"><tt class="py-docstring">        @warning:</tt> </tt>
<a name="L1149"></a><tt class="py-lineno">1149</tt>  <tt class="py-line"><tt class="py-docstring">            Do not confuse this method with the module level method</tt> </tt>
<a name="L1150"></a><tt class="py-lineno">1150</tt>  <tt class="py-line"><tt class="py-docstring">            L{record_from_id()&lt;bkn.bibtex.bibliography.record_from_id&gt;}.</tt> </tt>
<a name="L1151"></a><tt class="py-lineno">1151</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L1152"></a><tt class="py-lineno">1152</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">local_id</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">id_to_record_index</tt><tt class="py-op">.</tt><tt class="py-name">keys</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1153"></a><tt class="py-lineno">1153</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">id_to_record_index</tt><tt class="py-op">[</tt><tt class="py-name">local_id</tt><tt class="py-op">]</tt> </tt>
<a name="L1154"></a><tt class="py-lineno">1154</tt>  <tt class="py-line">        <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1155"></a><tt class="py-lineno">1155</tt>  <tt class="py-line">            <tt class="py-keyword">raise</tt> <tt id="link-162" class="py-name"><a title="bkn.bibtex.error.RecordNotFoundError" class="py-name" href="#" onclick="return doclink('link-162', 'RecordNotFoundError', 'link-41');">RecordNotFoundError</a></tt><tt class="py-op">(</tt> </tt>
<a name="L1156"></a><tt class="py-lineno">1156</tt>  <tt class="py-line">                <tt class="py-string">'No record with the id '</tt> <tt class="py-op">+</tt> <tt class="py-name">local_id</tt> <tt class="py-op">+</tt> </tt>
<a name="L1157"></a><tt class="py-lineno">1157</tt>  <tt class="py-line">                <tt class="py-string">' in this bibliography'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1158"></a><tt class="py-lineno">1158</tt>  <tt class="py-line"> </tt>
<a name="Bibliography.resolve_reference"></a><div id="Bibliography.resolve_reference-def"><a name="L1159"></a><tt class="py-lineno">1159</tt> <a class="py-toggle" href="#" id="Bibliography.resolve_reference-toggle" onclick="return toggle('Bibliography.resolve_reference');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography.Bibliography-class.html#resolve_reference">resolve_reference</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">ref</tt><tt class="py-op">,</tt> <tt class="py-param">resolve_local_refs_from_memory</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Bibliography.resolve_reference-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Bibliography.resolve_reference-expanded"><a name="L1160"></a><tt class="py-lineno">1160</tt>  <tt class="py-line">        <tt class="py-docstring">'''Attempts to resolve the given reference, returning the applicable Record if available.</tt> </tt>
<a name="L1161"></a><tt class="py-lineno">1161</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L1162"></a><tt class="py-lineno">1162</tt>  <tt class="py-line"><tt class="py-docstring">        Global references will always be resolved over the network or</tt> </tt>
<a name="L1163"></a><tt class="py-lineno">1163</tt>  <tt class="py-line"><tt class="py-docstring">        from local files, as appropriate. Local references will be</tt> </tt>
<a name="L1164"></a><tt class="py-lineno">1164</tt>  <tt class="py-line"><tt class="py-docstring">        resolved from the version of the Bibliography in memory if</tt> </tt>
<a name="L1165"></a><tt class="py-lineno">1165</tt>  <tt class="py-line"><tt class="py-docstring">        resolve_local_refs_from_memory is True (the default). Otherwise</tt> </tt>
<a name="L1166"></a><tt class="py-lineno">1166</tt>  <tt class="py-line"><tt class="py-docstring">        they will be converted to and resolved like any other global</tt> </tt>
<a name="L1167"></a><tt class="py-lineno">1167</tt>  <tt class="py-line"><tt class="py-docstring">        reference.</tt> </tt>
<a name="L1168"></a><tt class="py-lineno">1168</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L1169"></a><tt class="py-lineno">1169</tt>  <tt class="py-line"><tt class="py-docstring">        @param ref:</tt> </tt>
<a name="L1170"></a><tt class="py-lineno">1170</tt>  <tt class="py-line"><tt class="py-docstring">            The reference to be resolved. Global references should begin</tt> </tt>
<a name="L1171"></a><tt class="py-lineno">1171</tt>  <tt class="py-line"><tt class="py-docstring">            with '@@' and local references should begin with '@'.</tt> </tt>
<a name="L1172"></a><tt class="py-lineno">1172</tt>  <tt class="py-line"><tt class="py-docstring">        @type ref: str</tt> </tt>
<a name="L1173"></a><tt class="py-lineno">1173</tt>  <tt class="py-line"><tt class="py-docstring">        @param resolve_local_refs_from_memory:</tt> </tt>
<a name="L1174"></a><tt class="py-lineno">1174</tt>  <tt class="py-line"><tt class="py-docstring">            whether or not to resolve local references using the version</tt> </tt>
<a name="L1175"></a><tt class="py-lineno">1175</tt>  <tt class="py-line"><tt class="py-docstring">            of the Bibliography in memory.</tt> </tt>
<a name="L1176"></a><tt class="py-lineno">1176</tt>  <tt class="py-line"><tt class="py-docstring">        @type resolve_local_refs_from_memory: bool</tt> </tt>
<a name="L1177"></a><tt class="py-lineno">1177</tt>  <tt class="py-line"><tt class="py-docstring">        @return:</tt> </tt>
<a name="L1178"></a><tt class="py-lineno">1178</tt>  <tt class="py-line"><tt class="py-docstring">             the requested Record or None if the reference is cannot be</tt> </tt>
<a name="L1179"></a><tt class="py-lineno">1179</tt>  <tt class="py-line"><tt class="py-docstring">             resolved.</tt> </tt>
<a name="L1180"></a><tt class="py-lineno">1180</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: L{Record} or C{None}</tt> </tt>
<a name="L1181"></a><tt class="py-lineno">1181</tt>  <tt class="py-line"><tt class="py-docstring">        @raise InvalidReferenceError:</tt> </tt>
<a name="L1182"></a><tt class="py-lineno">1182</tt>  <tt class="py-line"><tt class="py-docstring">             if the requested reference was invalid.</tt> </tt>
<a name="L1183"></a><tt class="py-lineno">1183</tt>  <tt class="py-line"><tt class="py-docstring">        @raise RecordNotFoundError:</tt> </tt>
<a name="L1184"></a><tt class="py-lineno">1184</tt>  <tt class="py-line"><tt class="py-docstring">             if the requested reference can be resolved, and a response</tt> </tt>
<a name="L1185"></a><tt class="py-lineno">1185</tt>  <tt class="py-line"><tt class="py-docstring">             is retrieved, but the response does not contain the</tt> </tt>
<a name="L1186"></a><tt class="py-lineno">1186</tt>  <tt class="py-line"><tt class="py-docstring">             requested resource.</tt> </tt>
<a name="L1187"></a><tt class="py-lineno">1187</tt>  <tt class="py-line"><tt class="py-docstring">        @raise InvalidResponseError:</tt> </tt>
<a name="L1188"></a><tt class="py-lineno">1188</tt>  <tt class="py-line"><tt class="py-docstring">             if the requested reference can be resolved, and a response</tt> </tt>
<a name="L1189"></a><tt class="py-lineno">1189</tt>  <tt class="py-line"><tt class="py-docstring">             is retrieved, but the response is invalid.</tt> </tt>
<a name="L1190"></a><tt class="py-lineno">1190</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L1191"></a><tt class="py-lineno">1191</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">ref</tt><tt class="py-op">.</tt><tt class="py-name">startswith</tt><tt class="py-op">(</tt><tt class="py-string">'@@'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1192"></a><tt class="py-lineno">1192</tt>  <tt class="py-line">            <tt class="py-comment"># global reference</tt> </tt>
<a name="L1193"></a><tt class="py-lineno">1193</tt>  <tt class="py-line">            <tt class="py-comment"># global references must be URI's</tt> </tt>
<a name="L1194"></a><tt class="py-lineno">1194</tt>  <tt class="py-line">            <tt class="py-name">full_id</tt> <tt class="py-op">=</tt> <tt class="py-name">ref</tt><tt class="py-op">[</tt><tt class="py-number">2</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> <tt class="py-comment"># &lt;-- trim '@@'</tt> </tt>
<a name="L1195"></a><tt class="py-lineno">1195</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt id="link-163" class="py-name"><a title="bkn.bibtex.bibliography.Bibliography.record_from_id
bkn.bibtex.bibliography.record_from_id" class="py-name" href="#" onclick="return doclink('link-163', 'record_from_id', 'link-69');">record_from_id</a></tt><tt class="py-op">(</tt><tt class="py-name">full_id</tt><tt class="py-op">)</tt> </tt>
<a name="L1196"></a><tt class="py-lineno">1196</tt>  <tt class="py-line">        <tt class="py-keyword">elif</tt> <tt class="py-name">ref</tt><tt class="py-op">.</tt><tt class="py-name">startswith</tt><tt class="py-op">(</tt><tt class="py-string">'@'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1197"></a><tt class="py-lineno">1197</tt>  <tt class="py-line">            <tt class="py-comment"># local reference</tt> </tt>
<a name="L1198"></a><tt class="py-lineno">1198</tt>  <tt class="py-line">            <tt class="py-name">local_id</tt> <tt class="py-op">=</tt> <tt class="py-name">ref</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> <tt class="py-comment"># remove '@'</tt> </tt>
<a name="L1199"></a><tt class="py-lineno">1199</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">resolve_local_refs_from_memory</tt><tt class="py-op">:</tt> </tt>
<a name="L1200"></a><tt class="py-lineno">1200</tt>  <tt class="py-line">                <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-164" class="py-name"><a title="bkn.bibtex.bibliography.Bibliography.record_from_id
bkn.bibtex.bibliography.record_from_id" class="py-name" href="#" onclick="return doclink('link-164', 'record_from_id', 'link-69');">record_from_id</a></tt><tt class="py-op">(</tt><tt class="py-name">local_id</tt><tt class="py-op">)</tt> </tt>
<a name="L1201"></a><tt class="py-lineno">1201</tt>  <tt class="py-line">            <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1202"></a><tt class="py-lineno">1202</tt>  <tt class="py-line">                <tt class="py-name">full_id</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">metadata</tt><tt class="py-op">[</tt><tt class="py-string">u'id'</tt><tt class="py-op">]</tt> <tt class="py-op">+</tt> <tt class="py-name">local_id</tt> </tt>
<a name="L1203"></a><tt class="py-lineno">1203</tt>  <tt class="py-line">                <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-165" class="py-name" targets="Method bkn.bibtex.bibliography.Bibliography.resolve_reference()=bkn.bibtex.bibliography.Bibliography-class.html#resolve_reference"><a title="bkn.bibtex.bibliography.Bibliography.resolve_reference" class="py-name" href="#" onclick="return doclink('link-165', 'resolve_reference', 'link-165');">resolve_reference</a></tt><tt class="py-op">(</tt><tt class="py-string">'@@'</tt> <tt class="py-op">+</tt> <tt class="py-name">full_id</tt><tt class="py-op">)</tt> </tt>
<a name="L1204"></a><tt class="py-lineno">1204</tt>  <tt class="py-line">        <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1205"></a><tt class="py-lineno">1205</tt>  <tt class="py-line">            <tt class="py-keyword">raise</tt> <tt id="link-166" class="py-name"><a title="bkn.bibtex.error.BKNBibtexError" class="py-name" href="#" onclick="return doclink('link-166', 'BKNBibtexError', 'link-23');">BKNBibtexError</a></tt><tt class="py-op">(</tt> </tt>
<a name="L1206"></a><tt class="py-lineno">1206</tt>  <tt class="py-line">                <tt class="py-string">'"'</tt> <tt class="py-op">+</tt> <tt class="py-name">ref</tt> <tt class="py-op">+</tt> <tt class="py-string">'" is not a valid reference. '</tt> <tt class="py-op">+</tt> </tt>
<a name="L1207"></a><tt class="py-lineno">1207</tt>  <tt class="py-line">                <tt class="py-string">'Valid references should begin with an "@".'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1208"></a><tt class="py-lineno">1208</tt>  <tt class="py-line">     </tt>
<a name="Bibliography.fullref"></a><div id="Bibliography.fullref-def"><a name="L1209"></a><tt class="py-lineno">1209</tt> <a class="py-toggle" href="#" id="Bibliography.fullref-toggle" onclick="return toggle('Bibliography.fullref');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography.Bibliography-class.html#fullref">fullref</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">ref</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Bibliography.fullref-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Bibliography.fullref-expanded"><a name="L1210"></a><tt class="py-lineno">1210</tt>  <tt class="py-line">        <tt class="py-docstring">'''Takes a reference, local or global, and returns a global reference.</tt> </tt>
<a name="L1211"></a><tt class="py-lineno">1211</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L1212"></a><tt class="py-lineno">1212</tt>  <tt class="py-line"><tt class="py-docstring">        @note:</tt> </tt>
<a name="L1213"></a><tt class="py-lineno">1213</tt>  <tt class="py-line"><tt class="py-docstring">            a reference is simply a string composed of '@' plus the</tt> </tt>
<a name="L1214"></a><tt class="py-lineno">1214</tt>  <tt class="py-line"><tt class="py-docstring">            local id of a record or '@@' plus the global id of a record.</tt> </tt>
<a name="L1215"></a><tt class="py-lineno">1215</tt>  <tt class="py-line"><tt class="py-docstring">        @param ref: a reference</tt> </tt>
<a name="L1216"></a><tt class="py-lineno">1216</tt>  <tt class="py-line"><tt class="py-docstring">        @type ref: C{str}</tt> </tt>
<a name="L1217"></a><tt class="py-lineno">1217</tt>  <tt class="py-line"><tt class="py-docstring">        @return: a global reference</tt> </tt>
<a name="L1218"></a><tt class="py-lineno">1218</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: C{str}</tt> </tt>
<a name="L1219"></a><tt class="py-lineno">1219</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L1220"></a><tt class="py-lineno">1220</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">ref</tt><tt class="py-op">.</tt><tt class="py-name">startswith</tt><tt class="py-op">(</tt><tt class="py-string">u'@@'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1221"></a><tt class="py-lineno">1221</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-name">ref</tt> </tt>
<a name="L1222"></a><tt class="py-lineno">1222</tt>  <tt class="py-line">        <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1223"></a><tt class="py-lineno">1223</tt>  <tt class="py-line">           <tt class="py-keyword">return</tt> <tt class="py-string">u'@@'</tt> <tt class="py-op">+</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">metadata</tt><tt class="py-op">[</tt><tt class="py-string">u'id'</tt><tt class="py-op">]</tt> <tt class="py-op">+</tt> <tt class="py-name">ref</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> </tt>
</div><a name="L1224"></a><tt class="py-lineno">1224</tt>  <tt class="py-line">     </tt>
<a name="Bibliography.get_records_same_as"></a><div id="Bibliography.get_records_same_as-def"><a name="L1225"></a><tt class="py-lineno">1225</tt> <a class="py-toggle" href="#" id="Bibliography.get_records_same_as-toggle" onclick="return toggle('Bibliography.get_records_same_as');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography.Bibliography-class.html#get_records_same_as">get_records_same_as</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">id</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Bibliography.get_records_same_as-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Bibliography.get_records_same_as-expanded"><a name="L1226"></a><tt class="py-lineno">1226</tt>  <tt class="py-line">        <tt class="py-docstring">'''Identifies records which represent the same thing by following same-as assertions.</tt> </tt>
<a name="L1227"></a><tt class="py-lineno">1227</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L1228"></a><tt class="py-lineno">1228</tt>  <tt class="py-line"><tt class="py-docstring">        Same-as assertions may be included in a record by providing an</tt> </tt>
<a name="L1229"></a><tt class="py-lineno">1229</tt>  <tt class="py-line"><tt class="py-docstring">        attribute with the name "same-as" and a list of references as</tt> </tt>
<a name="L1230"></a><tt class="py-lineno">1230</tt>  <tt class="py-line"><tt class="py-docstring">        the value. For example, the same-as assertion in the this</tt> </tt>
<a name="L1231"></a><tt class="py-lineno">1231</tt>  <tt class="py-line"><tt class="py-docstring">        BibJSON record::</tt> </tt>
<a name="L1232"></a><tt class="py-lineno">1232</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L1233"></a><tt class="py-lineno">1233</tt>  <tt class="py-line"><tt class="py-docstring">            {</tt> </tt>
<a name="L1234"></a><tt class="py-lineno">1234</tt>  <tt class="py-line"><tt class="py-docstring">                "id" : "003",</tt> </tt>
<a name="L1235"></a><tt class="py-lineno">1235</tt>  <tt class="py-line"><tt class="py-docstring">                "type" : "article",</tt> </tt>
<a name="L1236"></a><tt class="py-lineno">1236</tt>  <tt class="py-line"><tt class="py-docstring">                "title" : "Duplicate Detection in Underwater Steelworks",</tt> </tt>
<a name="L1237"></a><tt class="py-lineno">1237</tt>  <tt class="py-line"><tt class="py-docstring">                "author" : "Mandavis Grazy",</tt> </tt>
<a name="L1238"></a><tt class="py-lineno">1238</tt>  <tt class="py-line"><tt class="py-docstring">                "same-as" : ["@001","@002","@@http://external.data/978"]</tt> </tt>
<a name="L1239"></a><tt class="py-lineno">1239</tt>  <tt class="py-line"><tt class="py-docstring">            }</tt> </tt>
<a name="L1240"></a><tt class="py-lineno">1240</tt>  <tt class="py-line"><tt class="py-docstring">            </tt> </tt>
<a name="L1241"></a><tt class="py-lineno">1241</tt>  <tt class="py-line"><tt class="py-docstring">        indicates that the given record represents the same article as</tt> </tt>
<a name="L1242"></a><tt class="py-lineno">1242</tt>  <tt class="py-line"><tt class="py-docstring">        is represented by record 001 and 002 in this dataset as well as</tt> </tt>
<a name="L1243"></a><tt class="py-lineno">1243</tt>  <tt class="py-line"><tt class="py-docstring">        the record with full id http://external.data/978 which may be in</tt> </tt>
<a name="L1244"></a><tt class="py-lineno">1244</tt>  <tt class="py-line"><tt class="py-docstring">        an external dataset.</tt> </tt>
<a name="L1245"></a><tt class="py-lineno">1245</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L1246"></a><tt class="py-lineno">1246</tt>  <tt class="py-line"><tt class="py-docstring">        Same-as assertions are symmetric. This method attempts to respect</tt> </tt>
<a name="L1247"></a><tt class="py-lineno">1247</tt>  <tt class="py-line"><tt class="py-docstring">        that, but same-as assertions must be indicated somewhere within</tt> </tt>
<a name="L1248"></a><tt class="py-lineno">1248</tt>  <tt class="py-line"><tt class="py-docstring">        a dataset in order to be observed by this method, i.e.</tt> </tt>
<a name="L1249"></a><tt class="py-lineno">1249</tt>  <tt class="py-line"><tt class="py-docstring">        assertions that only occur in external datasets will not be</tt> </tt>
<a name="L1250"></a><tt class="py-lineno">1250</tt>  <tt class="py-line"><tt class="py-docstring">        followed.</tt> </tt>
<a name="L1251"></a><tt class="py-lineno">1251</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L1252"></a><tt class="py-lineno">1252</tt>  <tt class="py-line"><tt class="py-docstring">        @param id: the id of record to be considered.</tt> </tt>
<a name="L1253"></a><tt class="py-lineno">1253</tt>  <tt class="py-line"><tt class="py-docstring">        @type id: C{str}</tt> </tt>
<a name="L1254"></a><tt class="py-lineno">1254</tt>  <tt class="py-line"><tt class="py-docstring">        @return: a list of L{Records&lt;Record&gt;}</tt> </tt>
<a name="L1255"></a><tt class="py-lineno">1255</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: C{list} of L{Records&lt;Record&gt;}</tt> </tt>
<a name="L1256"></a><tt class="py-lineno">1256</tt>  <tt class="py-line"><tt class="py-docstring">        @attention:</tt> </tt>
<a name="L1257"></a><tt class="py-lineno">1257</tt>  <tt class="py-line"><tt class="py-docstring">            this method takes the record in question's id as an</tt> </tt>
<a name="L1258"></a><tt class="py-lineno">1258</tt>  <tt class="py-line"><tt class="py-docstring">            argument, not the record itself.</tt> </tt>
<a name="L1259"></a><tt class="py-lineno">1259</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L1260"></a><tt class="py-lineno">1260</tt>  <tt class="py-line">        <tt class="py-name">result</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L1261"></a><tt class="py-lineno">1261</tt>  <tt class="py-line">        <tt class="py-keyword">for</tt> <tt class="py-name">record</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">:</tt> </tt>
<a name="L1262"></a><tt class="py-lineno">1262</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">record</tt><tt class="py-op">.</tt><tt id="link-167" class="py-name"><a title="bkn.bibtex.bibliography.Record.global_id" class="py-name" href="#" onclick="return doclink('link-167', 'global_id', 'link-55');">global_id</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-name">id</tt><tt class="py-op">:</tt> </tt>
<a name="L1263"></a><tt class="py-lineno">1263</tt>  <tt class="py-line">                <tt class="py-name">result</tt><tt class="py-op">.</tt><tt id="link-168" class="py-name"><a title="bkn.bibtex.bibliography.Bibliography.append" class="py-name" href="#" onclick="return doclink('link-168', 'append', 'link-157');">append</a></tt><tt class="py-op">(</tt><tt class="py-name">record</tt><tt class="py-op">)</tt> <tt class="py-comment"># include the record itself</tt> </tt>
<a name="L1264"></a><tt class="py-lineno">1264</tt>  <tt class="py-line">                <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">record</tt><tt class="py-op">.</tt><tt id="link-169" class="py-name"><a title="bkn.bibtex.bibliography.Record.attribute_is_blank" class="py-name" href="#" onclick="return doclink('link-169', 'attribute_is_blank', 'link-79');">attribute_is_blank</a></tt><tt class="py-op">(</tt><tt class="py-string">u'same-as'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1265"></a><tt class="py-lineno">1265</tt>  <tt class="py-line">                    <tt class="py-keyword">for</tt> <tt class="py-name">r</tt> <tt class="py-keyword">in</tt> <tt class="py-name">record</tt><tt class="py-op">[</tt><tt class="py-string">u'same-as'</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
<a name="L1266"></a><tt class="py-lineno">1266</tt>  <tt class="py-line">                        <tt class="py-name">result</tt><tt class="py-op">.</tt><tt id="link-170" class="py-name"><a title="bkn.bibtex.bibliography.Bibliography.append" class="py-name" href="#" onclick="return doclink('link-170', 'append', 'link-157');">append</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-171" class="py-name"><a title="bkn.bibtex.bibliography.Bibliography.resolve_reference" class="py-name" href="#" onclick="return doclink('link-171', 'resolve_reference', 'link-165');">resolve_reference</a></tt><tt class="py-op">(</tt><tt class="py-name">r</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1267"></a><tt class="py-lineno">1267</tt>  <tt class="py-line">                <tt class="py-keyword">continue</tt> </tt>
<a name="L1268"></a><tt class="py-lineno">1268</tt>  <tt class="py-line">            <tt class="py-name">same_as_refs</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-172" class="py-name" targets="Method bkn.bibtex.bibliography.Bibliography.fullref()=bkn.bibtex.bibliography.Bibliography-class.html#fullref"><a title="bkn.bibtex.bibliography.Bibliography.fullref" class="py-name" href="#" onclick="return doclink('link-172', 'fullref', 'link-172');">fullref</a></tt><tt class="py-op">(</tt><tt class="py-name">r</tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt class="py-name">r</tt> <tt class="py-keyword">in</tt> <tt class="py-name">record</tt><tt class="py-op">[</tt><tt class="py-string">u'same-as'</tt><tt class="py-op">]</tt><tt class="py-op">]</tt> </tt>
<a name="L1269"></a><tt class="py-lineno">1269</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-string">u'@@'</tt> <tt class="py-op">+</tt> <tt class="py-name">id</tt> <tt class="py-keyword">in</tt> <tt class="py-name">same_as_refs</tt><tt class="py-op">:</tt> </tt>
<a name="L1270"></a><tt class="py-lineno">1270</tt>  <tt class="py-line">               <tt class="py-name">result</tt><tt class="py-op">.</tt><tt id="link-173" class="py-name"><a title="bkn.bibtex.bibliography.Bibliography.append" class="py-name" href="#" onclick="return doclink('link-173', 'append', 'link-157');">append</a></tt><tt class="py-op">(</tt><tt class="py-name">record</tt><tt class="py-op">)</tt> </tt>
<a name="L1271"></a><tt class="py-lineno">1271</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">result</tt> </tt>
</div><a name="L1272"></a><tt class="py-lineno">1272</tt>  <tt class="py-line"> </tt>
<a name="Bibliography.get_unique_id"></a><div id="Bibliography.get_unique_id-def"><a name="L1273"></a><tt class="py-lineno">1273</tt> <a class="py-toggle" href="#" id="Bibliography.get_unique_id-toggle" onclick="return toggle('Bibliography.get_unique_id');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography.Bibliography-class.html#get_unique_id">get_unique_id</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">prefix</tt><tt class="py-op">=</tt><tt class="py-string">''</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Bibliography.get_unique_id-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Bibliography.get_unique_id-expanded"><a name="L1274"></a><tt class="py-lineno">1274</tt>  <tt class="py-line">        <tt class="py-docstring">'''Returns a string for use as an id in this bibliography.</tt> </tt>
<a name="L1275"></a><tt class="py-lineno">1275</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L1276"></a><tt class="py-lineno">1276</tt>  <tt class="py-line"><tt class="py-docstring">        @param prefix:</tt> </tt>
<a name="L1277"></a><tt class="py-lineno">1277</tt>  <tt class="py-line"><tt class="py-docstring">            if provided, the id will begin with the given prefix</tt> </tt>
<a name="L1278"></a><tt class="py-lineno">1278</tt>  <tt class="py-line"><tt class="py-docstring">        @type prefix: C{str}</tt> </tt>
<a name="L1279"></a><tt class="py-lineno">1279</tt>  <tt class="py-line"><tt class="py-docstring">        @return:</tt> </tt>
<a name="L1280"></a><tt class="py-lineno">1280</tt>  <tt class="py-line"><tt class="py-docstring">            a string which may be used as an id for a new record without</tt> </tt>
<a name="L1281"></a><tt class="py-lineno">1281</tt>  <tt class="py-line"><tt class="py-docstring">            conflicting with existing records in this Bibliography.</tt> </tt>
<a name="L1282"></a><tt class="py-lineno">1282</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: C{str}</tt> </tt>
<a name="L1283"></a><tt class="py-lineno">1283</tt>  <tt class="py-line"><tt class="py-docstring">        @todo: update tests for this method (the prefix keyword is new)</tt> </tt>
<a name="L1284"></a><tt class="py-lineno">1284</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L1285"></a><tt class="py-lineno">1285</tt>  <tt class="py-line">        <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L1286"></a><tt class="py-lineno">1286</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_unique_id_counter</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L1287"></a><tt class="py-lineno">1287</tt>  <tt class="py-line">        <tt class="py-keyword">except</tt> <tt class="py-name">AttributeError</tt><tt class="py-op">:</tt> </tt>
<a name="L1288"></a><tt class="py-lineno">1288</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_unique_id_counter</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L1289"></a><tt class="py-lineno">1289</tt>  <tt class="py-line">        <tt class="py-name">candidate_id</tt> <tt class="py-op">=</tt> <tt class="py-name">prefix</tt> <tt class="py-op">+</tt> <tt class="py-name">unicode</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_unique_id_counter</tt><tt class="py-op">)</tt> </tt>
<a name="L1290"></a><tt class="py-lineno">1290</tt>  <tt class="py-line">        <tt class="py-keyword">while</tt> <tt class="py-name">candidate_id</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">id_to_record_index</tt><tt class="py-op">.</tt><tt class="py-name">keys</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1291"></a><tt class="py-lineno">1291</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_unique_id_counter</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L1292"></a><tt class="py-lineno">1292</tt>  <tt class="py-line">            <tt class="py-name">candidate_id</tt> <tt class="py-op">=</tt> <tt class="py-name">prefix</tt> <tt class="py-op">+</tt> <tt class="py-name">unicode</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_unique_id_counter</tt><tt class="py-op">)</tt> </tt>
<a name="L1293"></a><tt class="py-lineno">1293</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">candidate_id</tt> </tt>
</div><a name="L1294"></a><tt class="py-lineno">1294</tt>  <tt class="py-line">     </tt>
<a name="L1295"></a><tt class="py-lineno">1295</tt>  <tt class="py-line">    <tt class="py-comment">#{ Serialization methods</tt> </tt>
<a name="L1296"></a><tt class="py-lineno">1296</tt>  <tt class="py-line">     </tt>
<a name="Bibliography.to_bibjson"></a><div id="Bibliography.to_bibjson-def"><a name="L1297"></a><tt class="py-lineno">1297</tt> <a class="py-toggle" href="#" id="Bibliography.to_bibjson-toggle" onclick="return toggle('Bibliography.to_bibjson');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography.Bibliography-class.html#to_bibjson">to_bibjson</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Bibliography.to_bibjson-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Bibliography.to_bibjson-expanded"><a name="L1298"></a><tt class="py-lineno">1298</tt>  <tt class="py-line">        <tt class="py-docstring">'''Returns the BibJSON serialization of this Bibliography.</tt> </tt>
<a name="L1299"></a><tt class="py-lineno">1299</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L1300"></a><tt class="py-lineno">1300</tt>  <tt class="py-line"><tt class="py-docstring">        @returns: the BibJSON serialization of this Bibliography.</tt> </tt>
<a name="L1301"></a><tt class="py-lineno">1301</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: C{str}</tt> </tt>
<a name="L1302"></a><tt class="py-lineno">1302</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L1303"></a><tt class="py-lineno">1303</tt>  <tt class="py-line">        <tt class="py-name">dataset</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L1304"></a><tt class="py-lineno">1304</tt>  <tt class="py-line">        <tt class="py-name">dataset</tt><tt class="py-op">.</tt><tt class="py-name">update</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">metadata</tt><tt class="py-op">)</tt> </tt>
<a name="L1305"></a><tt class="py-lineno">1305</tt>  <tt class="py-line">        <tt class="py-name">record_list</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L1306"></a><tt class="py-lineno">1306</tt>  <tt class="py-line">        <tt class="py-keyword">for</tt> <tt class="py-name">record</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">:</tt> </tt>
<a name="L1307"></a><tt class="py-lineno">1307</tt>  <tt class="py-line">            <tt class="py-name">record_list</tt><tt class="py-op">.</tt><tt id="link-174" class="py-name"><a title="bkn.bibtex.bibliography.Bibliography.append" class="py-name" href="#" onclick="return doclink('link-174', 'append', 'link-157');">append</a></tt><tt class="py-op">(</tt><tt class="py-name">record</tt><tt class="py-op">.</tt><tt class="py-name">attribute_map</tt><tt class="py-op">)</tt> </tt>
<a name="L1308"></a><tt class="py-lineno">1308</tt>  <tt class="py-line">        <tt class="py-name">result</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> <tt class="py-string">'dataset'</tt> <tt class="py-op">:</tt> <tt class="py-name">dataset</tt><tt class="py-op">,</tt> <tt class="py-string">'recordList'</tt> <tt class="py-op">:</tt> <tt class="py-name">record_list</tt> <tt class="py-op">}</tt> </tt>
<a name="L1309"></a><tt class="py-lineno">1309</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">json</tt><tt class="py-op">.</tt><tt class="py-name">dumps</tt><tt class="py-op">(</tt><tt class="py-name">result</tt><tt class="py-op">,</tt> <tt class="py-name">sort_keys</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">,</tt> <tt class="py-name">indent</tt><tt class="py-op">=</tt><tt class="py-number">4</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1310"></a><tt class="py-lineno">1310</tt>  <tt class="py-line">         </tt>
<a name="Bibliography.to_bibtex"></a><div id="Bibliography.to_bibtex-def"><a name="L1311"></a><tt class="py-lineno">1311</tt> <a class="py-toggle" href="#" id="Bibliography.to_bibtex-toggle" onclick="return toggle('Bibliography.to_bibtex');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography.Bibliography-class.html#to_bibtex">to_bibtex</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Bibliography.to_bibtex-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Bibliography.to_bibtex-expanded"><a name="L1312"></a><tt class="py-lineno">1312</tt>  <tt class="py-line">        <tt class="py-docstring">'''Returns the BibTeX serialization of this Bibliography.</tt> </tt>
<a name="L1313"></a><tt class="py-lineno">1313</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L1314"></a><tt class="py-lineno">1314</tt>  <tt class="py-line"><tt class="py-docstring">        @returns: the BibTeX serialization of this Bibliography.</tt> </tt>
<a name="L1315"></a><tt class="py-lineno">1315</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: C{str}</tt> </tt>
<a name="L1316"></a><tt class="py-lineno">1316</tt>  <tt class="py-line"><tt class="py-docstring">        @warning:</tt> </tt>
<a name="L1317"></a><tt class="py-lineno">1317</tt>  <tt class="py-line"><tt class="py-docstring">             Bibliographies with any attribute values which are not strings</tt> </tt>
<a name="L1318"></a><tt class="py-lineno">1318</tt>  <tt class="py-line"><tt class="py-docstring">             or integers may not be serialized in the BibTeX format.</tt> </tt>
<a name="L1319"></a><tt class="py-lineno">1319</tt>  <tt class="py-line"><tt class="py-docstring">        @todo: write tests for this method.</tt> </tt>
<a name="L1320"></a><tt class="py-lineno">1320</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L1321"></a><tt class="py-lineno">1321</tt>  <tt class="py-line">        <tt class="py-name">preamble</tt> <tt class="py-op">=</tt> <tt class="py-string">''</tt> </tt>
<a name="L1322"></a><tt class="py-lineno">1322</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">metadata</tt><tt class="py-op">.</tt><tt class="py-name">has_key</tt><tt class="py-op">(</tt><tt class="py-string">u'bibtex_preamble'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1323"></a><tt class="py-lineno">1323</tt>  <tt class="py-line">            <tt class="py-name">preamble</tt> <tt class="py-op">=</tt> <tt class="py-string">'@preamble{ "'</tt> <tt class="py-op">+</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">metadata</tt><tt class="py-op">[</tt><tt class="py-string">u'bibtex_preamble'</tt><tt class="py-op">]</tt> <tt class="py-op">+</tt> <tt class="py-string">'" }\n'</tt> </tt>
<a name="L1324"></a><tt class="py-lineno">1324</tt>  <tt class="py-line">        <tt class="py-name">formatted_entries</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">e</tt><tt class="py-op">.</tt><tt id="link-175" class="py-name"><a title="bkn.bibtex.bibliography.Bibliography.to_bibtex
bkn.bibtex.bibliography.Record.to_bibtex" class="py-name" href="#" onclick="return doclink('link-175', 'to_bibtex', 'link-82');">to_bibtex</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt class="py-name">e</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">]</tt> </tt>
<a name="L1325"></a><tt class="py-lineno">1325</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">preamble</tt> <tt class="py-op">+</tt> <tt class="py-string">'\n'</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">formatted_entries</tt><tt class="py-op">)</tt>     </tt>
</div><a name="L1326"></a><tt class="py-lineno">1326</tt>  <tt class="py-line">     </tt>
<a name="L1327"></a><tt class="py-lineno">1327</tt>  <tt class="py-line">    <tt class="py-comment">#{ Enhancing and modifying Bibliographies</tt> </tt>
<a name="L1328"></a><tt class="py-lineno">1328</tt>  <tt class="py-line">     </tt>
<a name="Bibliography.set_id"></a><div id="Bibliography.set_id-def"><a name="L1329"></a><tt class="py-lineno">1329</tt> <a class="py-toggle" href="#" id="Bibliography.set_id-toggle" onclick="return toggle('Bibliography.set_id');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography.Bibliography-class.html#set_id">set_id</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">id</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Bibliography.set_id-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Bibliography.set_id-expanded"><a name="L1330"></a><tt class="py-lineno">1330</tt>  <tt class="py-line">        <tt class="py-docstring">'''The preferred way to set this bibliographies id. Other methods</tt> </tt>
<a name="L1331"></a><tt class="py-lineno">1331</tt>  <tt class="py-line"><tt class="py-docstring">        may interfere with proper bibliography caching.</tt> </tt>
<a name="L1332"></a><tt class="py-lineno">1332</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L1333"></a><tt class="py-lineno">1333</tt>  <tt class="py-line"><tt class="py-docstring">        @param id: the new id for this Bibliography.</tt> </tt>
<a name="L1334"></a><tt class="py-lineno">1334</tt>  <tt class="py-line"><tt class="py-docstring">        @type id: str</tt> </tt>
<a name="L1335"></a><tt class="py-lineno">1335</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: C{None}</tt> </tt>
<a name="L1336"></a><tt class="py-lineno">1336</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L1337"></a><tt class="py-lineno">1337</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">id</tt><tt class="py-op">,</tt> <tt class="py-name">types</tt><tt class="py-op">.</tt><tt class="py-name">StringTypes</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1338"></a><tt class="py-lineno">1338</tt>  <tt class="py-line">            <tt class="py-keyword">raise</tt> <tt id="link-176" class="py-name"><a title="bkn.bibtex.error.BKNBibtexError" class="py-name" href="#" onclick="return doclink('link-176', 'BKNBibtexError', 'link-23');">BKNBibtexError</a></tt><tt class="py-op">(</tt><tt class="py-string">'Dataset id must be a string'</tt><tt class="py-op">)</tt> </tt>
<a name="L1339"></a><tt class="py-lineno">1339</tt>  <tt class="py-line">        <tt class="py-keyword">del</tt> <tt id="link-177" class="py-name"><a title="bkn.bibtex.bibliography.bib_cache" class="py-name" href="#" onclick="return doclink('link-177', 'bib_cache', 'link-49');">bib_cache</a></tt><tt class="py-op">[</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">metadata</tt><tt class="py-op">[</tt><tt class="py-string">u'id'</tt><tt class="py-op">]</tt><tt class="py-op">]</tt> </tt>
<a name="L1340"></a><tt class="py-lineno">1340</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">metadata</tt><tt class="py-op">[</tt><tt class="py-string">u'id'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">id</tt> </tt>
<a name="L1341"></a><tt class="py-lineno">1341</tt>  <tt class="py-line">        <tt id="link-178" class="py-name"><a title="bkn.bibtex.bibliography.bib_cache" class="py-name" href="#" onclick="return doclink('link-178', 'bib_cache', 'link-49');">bib_cache</a></tt><tt class="py-op">[</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">metadata</tt><tt class="py-op">[</tt><tt class="py-string">u'id'</tt><tt class="py-op">]</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt> </tt>
</div><a name="L1342"></a><tt class="py-lineno">1342</tt>  <tt class="py-line">             </tt>
<a name="Bibliography.add_bibtex_output"></a><div id="Bibliography.add_bibtex_output-def"><a name="L1343"></a><tt class="py-lineno">1343</tt> <a class="py-toggle" href="#" id="Bibliography.add_bibtex_output-toggle" onclick="return toggle('Bibliography.add_bibtex_output');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography.Bibliography-class.html#add_bibtex_output">add_bibtex_output</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">style</tt><tt class="py-op">=</tt><tt class="py-string">'abbrv'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Bibliography.add_bibtex_output-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Bibliography.add_bibtex_output-expanded"><a name="L1344"></a><tt class="py-lineno">1344</tt>  <tt class="py-line">        <tt class="py-docstring">'''For every record, adds a bibtex_out attribute whose contents is</tt> </tt>
<a name="L1345"></a><tt class="py-lineno">1345</tt>  <tt class="py-line"><tt class="py-docstring">        the the result of running bibtex on the entry with specified</tt> </tt>
<a name="L1346"></a><tt class="py-lineno">1346</tt>  <tt class="py-line"><tt class="py-docstring">        style.</tt> </tt>
<a name="L1347"></a><tt class="py-lineno">1347</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1348"></a><tt class="py-lineno">1348</tt>  <tt class="py-line"><tt class="py-docstring">        A C{bibtex_warnings} attribute is also added, which is a list of any</tt> </tt>
<a name="L1349"></a><tt class="py-lineno">1349</tt>  <tt class="py-line"><tt class="py-docstring">        warnings generated by bibtex for an entry.</tt> </tt>
<a name="L1350"></a><tt class="py-lineno">1350</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L1351"></a><tt class="py-lineno">1351</tt>  <tt class="py-line"><tt class="py-docstring">        @param style:</tt> </tt>
<a name="L1352"></a><tt class="py-lineno">1352</tt>  <tt class="py-line"><tt class="py-docstring">            the BibTeX style to be used. The specified style must be</tt> </tt>
<a name="L1353"></a><tt class="py-lineno">1353</tt>  <tt class="py-line"><tt class="py-docstring">            installed on your system.</tt> </tt>
<a name="L1354"></a><tt class="py-lineno">1354</tt>  <tt class="py-line"><tt class="py-docstring">        @type style: str</tt> </tt>
<a name="L1355"></a><tt class="py-lineno">1355</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: C{None}</tt> </tt>
<a name="L1356"></a><tt class="py-lineno">1356</tt>  <tt class="py-line"><tt class="py-docstring">        @raise ExternalError:</tt> </tt>
<a name="L1357"></a><tt class="py-lineno">1357</tt>  <tt class="py-line"><tt class="py-docstring">            if python can't find or run the bibtex executable.</tt> </tt>
<a name="L1358"></a><tt class="py-lineno">1358</tt>  <tt class="py-line"><tt class="py-docstring">        @raise ExternalError:</tt> </tt>
<a name="L1359"></a><tt class="py-lineno">1359</tt>  <tt class="py-line"><tt class="py-docstring">            if bibtex does not return the expected output.</tt> </tt>
<a name="L1360"></a><tt class="py-lineno">1360</tt>  <tt class="py-line"><tt class="py-docstring">        @raise BibTeXError:</tt> </tt>
<a name="L1361"></a><tt class="py-lineno">1361</tt>  <tt class="py-line"><tt class="py-docstring">            if bibtex encounters an error.</tt> </tt>
<a name="L1362"></a><tt class="py-lineno">1362</tt>  <tt class="py-line"><tt class="py-docstring">        @todo:</tt> </tt>
<a name="L1363"></a><tt class="py-lineno">1363</tt>  <tt class="py-line"><tt class="py-docstring">            this method should only attempt to create bibtex output for</tt> </tt>
<a name="L1364"></a><tt class="py-lineno">1364</tt>  <tt class="py-line"><tt class="py-docstring">            those records which represent bibliographic items. (Records</tt> </tt>
<a name="L1365"></a><tt class="py-lineno">1365</tt>  <tt class="py-line"><tt class="py-docstring">            for authors, institutions, and the like should be ignored.)</tt> </tt>
<a name="L1366"></a><tt class="py-lineno">1366</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L1367"></a><tt class="py-lineno">1367</tt>  <tt class="py-line">        <tt id="link-179" class="py-name" targets="Class bkn.bibtex.bibliography._AddBibtexOutputEnchancer=bkn.bibtex.bibliography._AddBibtexOutputEnchancer-class.html"><a title="bkn.bibtex.bibliography._AddBibtexOutputEnchancer" class="py-name" href="#" onclick="return doclink('link-179', '_AddBibtexOutputEnchancer', 'link-179');">_AddBibtexOutputEnchancer</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">style</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt id="link-180" class="py-name" targets="Method bkn.bibtex.bibliography._AddBibtexOutputEnchancer.compute()=bkn.bibtex.bibliography._AddBibtexOutputEnchancer-class.html#compute"><a title="bkn.bibtex.bibliography._AddBibtexOutputEnchancer.compute" class="py-name" href="#" onclick="return doclink('link-180', 'compute', 'link-180');">compute</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1368"></a><tt class="py-lineno">1368</tt>  <tt class="py-line">                 </tt>
<a name="L1369"></a><tt class="py-lineno">1369</tt>  <tt class="py-line">    <tt class="py-comment">#{ Other methods</tt> </tt>
<a name="L1370"></a><tt class="py-lineno">1370</tt>  <tt class="py-line">             </tt>
<a name="Bibliography.validate_record"></a><div id="Bibliography.validate_record-def"><a name="L1371"></a><tt class="py-lineno">1371</tt> <a class="py-toggle" href="#" id="Bibliography.validate_record-toggle" onclick="return toggle('Bibliography.validate_record');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography.Bibliography-class.html#validate_record">validate_record</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">record</tt><tt class="py-op">,</tt> <tt class="py-param">raise_error</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Bibliography.validate_record-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Bibliography.validate_record-expanded"><a name="L1372"></a><tt class="py-lineno">1372</tt>  <tt class="py-line">        <tt class="py-docstring">'''Returns True if the passed record is valid, otherwise returns False.</tt> </tt>
<a name="L1373"></a><tt class="py-lineno">1373</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L1374"></a><tt class="py-lineno">1374</tt>  <tt class="py-line"><tt class="py-docstring">        @param raise_error:</tt> </tt>
<a name="L1375"></a><tt class="py-lineno">1375</tt>  <tt class="py-line"><tt class="py-docstring">            if C{True} then raise a InvalidRecordError instead of</tt> </tt>
<a name="L1376"></a><tt class="py-lineno">1376</tt>  <tt class="py-line"><tt class="py-docstring">            returning.</tt> </tt>
<a name="L1377"></a><tt class="py-lineno">1377</tt>  <tt class="py-line"><tt class="py-docstring">        @type raise_error: C{bool}</tt> </tt>
<a name="L1378"></a><tt class="py-lineno">1378</tt>  <tt class="py-line"><tt class="py-docstring">        @raise InvalidRecordError:</tt> </tt>
<a name="L1379"></a><tt class="py-lineno">1379</tt>  <tt class="py-line"><tt class="py-docstring">            if the record is invalid and C{raise_error} is C{True}</tt> </tt>
<a name="L1380"></a><tt class="py-lineno">1380</tt>  <tt class="py-line"><tt class="py-docstring">        @return:</tt> </tt>
<a name="L1381"></a><tt class="py-lineno">1381</tt>  <tt class="py-line"><tt class="py-docstring">            C{True} if the passed record is valid, and C{False}</tt> </tt>
<a name="L1382"></a><tt class="py-lineno">1382</tt>  <tt class="py-line"><tt class="py-docstring">            otherwise.</tt> </tt>
<a name="L1383"></a><tt class="py-lineno">1383</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: C{bool}</tt> </tt>
<a name="L1384"></a><tt class="py-lineno">1384</tt>  <tt class="py-line"><tt class="py-docstring">        @note:</tt> </tt>
<a name="L1385"></a><tt class="py-lineno">1385</tt>  <tt class="py-line"><tt class="py-docstring">            currently this method only checks that the 'type' and 'id'</tt> </tt>
<a name="L1386"></a><tt class="py-lineno">1386</tt>  <tt class="py-line"><tt class="py-docstring">            attributes are strings.</tt> </tt>
<a name="L1387"></a><tt class="py-lineno">1387</tt>  <tt class="py-line"><tt class="py-docstring">        @todo:</tt> </tt>
<a name="L1388"></a><tt class="py-lineno">1388</tt>  <tt class="py-line"><tt class="py-docstring">            should check against this bibliography's schema</tt> </tt>
<a name="L1389"></a><tt class="py-lineno">1389</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L1390"></a><tt class="py-lineno">1390</tt>  <tt class="py-line">        <tt class="py-keyword">def</tt> <tt class="py-def-name">fail</tt><tt class="py-op">(</tt><tt class="py-param">string</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1391"></a><tt class="py-lineno">1391</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">raise_error</tt><tt class="py-op">:</tt> </tt>
<a name="L1392"></a><tt class="py-lineno">1392</tt>  <tt class="py-line">                <tt class="py-keyword">raise</tt> <tt id="link-181" class="py-name"><a title="bkn.bibtex.error.InvalidRecordError" class="py-name" href="#" onclick="return doclink('link-181', 'InvalidRecordError', 'link-32');">InvalidRecordError</a></tt><tt class="py-op">(</tt><tt class="py-name">string</tt><tt class="py-op">)</tt> </tt>
<a name="L1393"></a><tt class="py-lineno">1393</tt>  <tt class="py-line">            <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1394"></a><tt class="py-lineno">1394</tt>  <tt class="py-line">                <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
</div><a name="L1395"></a><tt class="py-lineno">1395</tt>  <tt class="py-line">        <tt class="py-comment"># type must be a string</tt> </tt>
<a name="L1396"></a><tt class="py-lineno">1396</tt>  <tt class="py-line">        <tt class="py-keyword">for</tt> <tt class="py-name">attr_name</tt> <tt class="py-keyword">in</tt> <tt class="py-op">[</tt><tt class="py-string">u'id'</tt><tt class="py-op">,</tt> <tt class="py-string">u'type'</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
<a name="L1397"></a><tt class="py-lineno">1397</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">record</tt><tt class="py-op">[</tt><tt class="py-name">attr_name</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">types</tt><tt class="py-op">.</tt><tt class="py-name">StringTypes</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1398"></a><tt class="py-lineno">1398</tt>  <tt class="py-line">                <tt class="py-name">fail</tt><tt class="py-op">(</tt><tt class="py-string">'The '</tt> <tt class="py-op">+</tt> <tt class="py-name">attr_name</tt> <tt class="py-op">+</tt> <tt class="py-string">' attribute must take a string value.'</tt><tt class="py-op">)</tt> </tt>
<a name="L1399"></a><tt class="py-lineno">1399</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>
</div><a name="L1400"></a><tt class="py-lineno">1400</tt>  <tt class="py-line">     </tt>
<a name="Bibliography.values_equal"></a><div id="Bibliography.values_equal-def"><a name="L1401"></a><tt class="py-lineno">1401</tt> <a class="py-toggle" href="#" id="Bibliography.values_equal-toggle" onclick="return toggle('Bibliography.values_equal');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography.Bibliography-class.html#values_equal">values_equal</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">other</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Bibliography.values_equal-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Bibliography.values_equal-expanded"><a name="L1402"></a><tt class="py-lineno">1402</tt>  <tt class="py-line">        <tt class="py-docstring">'''Returns true if this Bibliography has the same content as the given Bibliography.</tt> </tt>
<a name="L1403"></a><tt class="py-lineno">1403</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L1404"></a><tt class="py-lineno">1404</tt>  <tt class="py-line"><tt class="py-docstring">        Distinct Bibliographies will always compare as not equal. This method may</tt> </tt>
<a name="L1405"></a><tt class="py-lineno">1405</tt>  <tt class="py-line"><tt class="py-docstring">        be used to compare Records based upon their content.</tt> </tt>
<a name="L1406"></a><tt class="py-lineno">1406</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L1407"></a><tt class="py-lineno">1407</tt>  <tt class="py-line"><tt class="py-docstring">            &gt;&gt;&gt; bib2 = copy.deepcopy(bib1)</tt> </tt>
<a name="L1408"></a><tt class="py-lineno">1408</tt>  <tt class="py-line"><tt class="py-docstring">            &gt;&gt;&gt; bib1 == bib2</tt> </tt>
<a name="L1409"></a><tt class="py-lineno">1409</tt>  <tt class="py-line"><tt class="py-docstring">            ... False</tt> </tt>
<a name="L1410"></a><tt class="py-lineno">1410</tt>  <tt class="py-line"><tt class="py-docstring">            &gt;&gt;&gt; bib1.values_equal(bib2)</tt> </tt>
<a name="L1411"></a><tt class="py-lineno">1411</tt>  <tt class="py-line"><tt class="py-docstring">            ... True</tt> </tt>
<a name="L1412"></a><tt class="py-lineno">1412</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L1413"></a><tt class="py-lineno">1413</tt>  <tt class="py-line"><tt class="py-docstring">        @param other: the Bibliography to which this Bibliography should be compared.</tt> </tt>
<a name="L1414"></a><tt class="py-lineno">1414</tt>  <tt class="py-line"><tt class="py-docstring">        @type other: Bibliography</tt> </tt>
<a name="L1415"></a><tt class="py-lineno">1415</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: C{bool}</tt> </tt>
<a name="L1416"></a><tt class="py-lineno">1416</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L1417"></a><tt class="py-lineno">1417</tt>  <tt class="py-line">        <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L1418"></a><tt class="py-lineno">1418</tt>  <tt class="py-line">            <tt class="py-keyword">for</tt> <tt class="py-name">i</tt> <tt class="py-keyword">in</tt> <tt class="py-name">range</tt><tt class="py-op">(</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1419"></a><tt class="py-lineno">1419</tt>  <tt class="py-line">                <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">self</tt><tt class="py-op">[</tt><tt class="py-name">i</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt id="link-182" class="py-name" targets="Method bkn.bibtex.bibliography.Bibliography.values_equal()=bkn.bibtex.bibliography.Bibliography-class.html#values_equal,Method bkn.bibtex.bibliography.Record.values_equal()=bkn.bibtex.bibliography.Record-class.html#values_equal"><a title="bkn.bibtex.bibliography.Bibliography.values_equal
bkn.bibtex.bibliography.Record.values_equal" class="py-name" href="#" onclick="return doclink('link-182', 'values_equal', 'link-182');">values_equal</a></tt><tt class="py-op">(</tt><tt class="py-name">other</tt><tt class="py-op">[</tt><tt class="py-name">i</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1420"></a><tt class="py-lineno">1420</tt>  <tt class="py-line">                    <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
<a name="L1421"></a><tt class="py-lineno">1421</tt>  <tt class="py-line">        <tt class="py-keyword">except</tt> <tt class="py-name">IndexError</tt><tt class="py-op">:</tt> </tt>
<a name="L1422"></a><tt class="py-lineno">1422</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
<a name="L1423"></a><tt class="py-lineno">1423</tt>  <tt class="py-line">        <tt class="py-keyword">except</tt> <tt class="py-name">AttributeError</tt><tt class="py-op">:</tt> </tt>
<a name="L1424"></a><tt class="py-lineno">1424</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
<a name="L1425"></a><tt class="py-lineno">1425</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>
</div><a name="L1426"></a><tt class="py-lineno">1426</tt>  <tt class="py-line"> </tt>
<a name="Bibliography.__str__"></a><div id="Bibliography.__str__-def"><a name="L1427"></a><tt class="py-lineno">1427</tt> <a class="py-toggle" href="#" id="Bibliography.__str__-toggle" onclick="return toggle('Bibliography.__str__');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography.Bibliography-class.html#__str__">__str__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Bibliography.__str__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Bibliography.__str__-expanded"><a name="L1428"></a><tt class="py-lineno">1428</tt>  <tt class="py-line">        <tt class="py-docstring">'''Returns an informal string representation of this record</tt> </tt>
<a name="L1429"></a><tt class="py-lineno">1429</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L1430"></a><tt class="py-lineno">1430</tt>  <tt class="py-line"><tt class="py-docstring">        @return:</tt> </tt>
<a name="L1431"></a><tt class="py-lineno">1431</tt>  <tt class="py-line"><tt class="py-docstring">            The current implementation calls to_bibtex(). (This may</tt> </tt>
<a name="L1432"></a><tt class="py-lineno">1432</tt>  <tt class="py-line"><tt class="py-docstring">            change in future versions.</tt> </tt>
<a name="L1433"></a><tt class="py-lineno">1433</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: C{str}</tt> </tt>
<a name="L1434"></a><tt class="py-lineno">1434</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L1435"></a><tt class="py-lineno">1435</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-183" class="py-name"><a title="bkn.bibtex.bibliography.Bibliography.to_bibtex
bkn.bibtex.bibliography.Record.to_bibtex" class="py-name" href="#" onclick="return doclink('link-183', 'to_bibtex', 'link-82');">to_bibtex</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1436"></a><tt class="py-lineno">1436</tt>  <tt class="py-line"> </tt>
<a name="Bibliography.__getattr__"></a><div id="Bibliography.__getattr__-def"><a name="L1437"></a><tt class="py-lineno">1437</tt> <a class="py-toggle" href="#" id="Bibliography.__getattr__-toggle" onclick="return toggle('Bibliography.__getattr__');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography.Bibliography-class.html#__getattr__">__getattr__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">name</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Bibliography.__getattr__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Bibliography.__getattr__-expanded"><a name="L1438"></a><tt class="py-lineno">1438</tt>  <tt class="py-line">        <tt class="py-docstring">'''Handles attribute access for deprecated attributes and methods.</tt> </tt>
<a name="L1439"></a><tt class="py-lineno">1439</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L1440"></a><tt class="py-lineno">1440</tt>  <tt class="py-line"><tt class="py-docstring">        @param name: the name of the requested attribute.</tt> </tt>
<a name="L1441"></a><tt class="py-lineno">1441</tt>  <tt class="py-line"><tt class="py-docstring">        @type name: str</tt> </tt>
<a name="L1442"></a><tt class="py-lineno">1442</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: C{object}</tt> </tt>
<a name="L1443"></a><tt class="py-lineno">1443</tt>  <tt class="py-line"><tt class="py-docstring">        @note:</tt> </tt>
<a name="L1444"></a><tt class="py-lineno">1444</tt>  <tt class="py-line"><tt class="py-docstring">            'attribute' in this context refers to a python attribute,</tt> </tt>
<a name="L1445"></a><tt class="py-lineno">1445</tt>  <tt class="py-line"><tt class="py-docstring">            not to a BibJSON attribute.</tt> </tt>
<a name="L1446"></a><tt class="py-lineno">1446</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt>                 </tt>
<a name="L1447"></a><tt class="py-lineno">1447</tt>  <tt class="py-line">        <tt class="py-name">deprecated_attributes</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> </tt>
<a name="L1448"></a><tt class="py-lineno">1448</tt>  <tt class="py-line">            <tt class="py-string">'entries'</tt> <tt class="py-op">:</tt> <tt class="py-string">'record_list'</tt><tt class="py-op">,</tt> </tt>
<a name="L1449"></a><tt class="py-lineno">1449</tt>  <tt class="py-line">            <tt class="py-string">'add_entry'</tt> <tt class="py-op">:</tt> <tt class="py-string">'add_record'</tt><tt class="py-op">,</tt> </tt>
<a name="L1450"></a><tt class="py-lineno">1450</tt>  <tt class="py-line">            <tt class="py-string">'remove_entry'</tt> <tt class="py-op">:</tt> <tt class="py-string">'remove_record'</tt><tt class="py-op">,</tt> </tt>
<a name="L1451"></a><tt class="py-lineno">1451</tt>  <tt class="py-line">            <tt class="py-string">'entry_from_id'</tt> <tt class="py-op">:</tt> <tt class="py-string">'record_from_id'</tt> </tt>
<a name="L1452"></a><tt class="py-lineno">1452</tt>  <tt class="py-line">        <tt class="py-op">}</tt> </tt>
<a name="L1453"></a><tt class="py-lineno">1453</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">name</tt> <tt class="py-keyword">in</tt> <tt class="py-name">deprecated_attributes</tt><tt class="py-op">.</tt><tt class="py-name">keys</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1454"></a><tt class="py-lineno">1454</tt>  <tt class="py-line">            <tt class="py-name">warnings</tt><tt class="py-op">.</tt><tt class="py-name">warn</tt><tt class="py-op">(</tt> </tt>
<a name="L1455"></a><tt class="py-lineno">1455</tt>  <tt class="py-line">                <tt class="py-string">'The '</tt> <tt class="py-op">+</tt> <tt class="py-name">name</tt> <tt class="py-op">+</tt> <tt class="py-string">' attribute has been deprecated. '</tt> <tt class="py-op">+</tt> </tt>
<a name="L1456"></a><tt class="py-lineno">1456</tt>  <tt class="py-line">                <tt class="py-string">'Please use "'</tt> <tt class="py-op">+</tt> <tt class="py-name">deprecated_attributes</tt><tt class="py-op">[</tt><tt class="py-name">name</tt><tt class="py-op">]</tt> <tt class="py-op">+</tt> <tt class="py-string">'" instead.'</tt><tt class="py-op">,</tt> </tt>
<a name="L1457"></a><tt class="py-lineno">1457</tt>  <tt class="py-line">                <tt class="py-name">DeprecationWarning</tt><tt class="py-op">,</tt> <tt class="py-name">stacklevel</tt><tt class="py-op">=</tt><tt class="py-number">2</tt><tt class="py-op">)</tt> </tt>
<a name="L1458"></a><tt class="py-lineno">1458</tt>  <tt class="py-line">            <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L1459"></a><tt class="py-lineno">1459</tt>  <tt class="py-line">                <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__dict__</tt><tt class="py-op">[</tt><tt class="py-name">deprecated_attributes</tt><tt class="py-op">[</tt><tt class="py-name">name</tt><tt class="py-op">]</tt><tt class="py-op">]</tt> </tt>
<a name="L1460"></a><tt class="py-lineno">1460</tt>  <tt class="py-line">            <tt class="py-keyword">except</tt> <tt class="py-name">KeyError</tt><tt class="py-op">:</tt> </tt>
<a name="L1461"></a><tt class="py-lineno">1461</tt>  <tt class="py-line">                <tt class="py-comment"># if deprecated_attributes[name] was not found in the</tt> </tt>
<a name="L1462"></a><tt class="py-lineno">1462</tt>  <tt class="py-line">                <tt class="py-comment"># __dict__ for this instance then we assume it was a</tt> </tt>
<a name="L1463"></a><tt class="py-lineno">1463</tt>  <tt class="py-line">                <tt class="py-comment"># method--and methods are stored as attributes of the class.</tt> </tt>
<a name="L1464"></a><tt class="py-lineno">1464</tt>  <tt class="py-line">                <tt class="py-keyword">return</tt> <tt id="link-184" class="py-name"><a title="bkn.bibtex.bibliography.Bibliography" class="py-name" href="#" onclick="return doclink('link-184', 'Bibliography', 'link-53');">Bibliography</a></tt><tt class="py-op">.</tt><tt class="py-name">__dict__</tt><tt class="py-op">[</tt><tt class="py-name">deprecated_attributes</tt><tt class="py-op">[</tt><tt class="py-name">name</tt><tt class="py-op">]</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">__get__</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt id="link-185" class="py-name"><a title="bkn.bibtex.bibliography.Bibliography" class="py-name" href="#" onclick="return doclink('link-185', 'Bibliography', 'link-53');">Bibliography</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1465"></a><tt class="py-lineno">1465</tt>  <tt class="py-line">        <tt class="py-keyword">raise</tt> <tt class="py-name">AttributeError</tt><tt class="py-op">(</tt><tt class="py-name">name</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L1466"></a><tt class="py-lineno">1466</tt>  <tt class="py-line">         </tt>
<a name="_AddBibtexOutputEnchancer"></a><div id="_AddBibtexOutputEnchancer-def"><a name="L1467"></a><tt class="py-lineno">1467</tt> <a class="py-toggle" href="#" id="_AddBibtexOutputEnchancer-toggle" onclick="return toggle('_AddBibtexOutputEnchancer');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="bkn.bibtex.bibliography._AddBibtexOutputEnchancer-class.html">_AddBibtexOutputEnchancer</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_AddBibtexOutputEnchancer-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_AddBibtexOutputEnchancer-expanded"><a name="L1468"></a><tt class="py-lineno">1468</tt>  <tt class="py-line">    <tt class="py-docstring">'''A method object for adding the output of the BibTeX executable to a Bibliography.</tt> </tt>
<a name="L1469"></a><tt class="py-lineno">1469</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1470"></a><tt class="py-lineno">1470</tt>  <tt class="py-line"><tt class="py-docstring">    This class is used by Bibliography's add_bibtex_output() method.</tt> </tt>
<a name="L1471"></a><tt class="py-lineno">1471</tt>  <tt class="py-line"><tt class="py-docstring">    '''</tt> </tt>
<a name="_AddBibtexOutputEnchancer.__init__"></a><div id="_AddBibtexOutputEnchancer.__init__-def"><a name="L1472"></a><tt class="py-lineno">1472</tt> <a class="py-toggle" href="#" id="_AddBibtexOutputEnchancer.__init__-toggle" onclick="return toggle('_AddBibtexOutputEnchancer.__init__');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography._AddBibtexOutputEnchancer-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">bib</tt><tt class="py-op">,</tt> <tt class="py-param">style</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_AddBibtexOutputEnchancer.__init__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="_AddBibtexOutputEnchancer.__init__-expanded"><a name="L1473"></a><tt class="py-lineno">1473</tt>  <tt class="py-line">        <tt class="py-docstring">'''Creates a new _AddBibtexOutputEnchancer using the supplied Bibliography and style.</tt> </tt>
<a name="L1474"></a><tt class="py-lineno">1474</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L1475"></a><tt class="py-lineno">1475</tt>  <tt class="py-line"><tt class="py-docstring">        @param bib: the Bibliography to enhance.</tt> </tt>
<a name="L1476"></a><tt class="py-lineno">1476</tt>  <tt class="py-line"><tt class="py-docstring">        @type bib: L{Bibliography}</tt> </tt>
<a name="L1477"></a><tt class="py-lineno">1477</tt>  <tt class="py-line"><tt class="py-docstring">        @param style:</tt> </tt>
<a name="L1478"></a><tt class="py-lineno">1478</tt>  <tt class="py-line"><tt class="py-docstring">            the BibTeX style to be used. The specified style must be</tt> </tt>
<a name="L1479"></a><tt class="py-lineno">1479</tt>  <tt class="py-line"><tt class="py-docstring">            installed on your system.</tt> </tt>
<a name="L1480"></a><tt class="py-lineno">1480</tt>  <tt class="py-line"><tt class="py-docstring">        @type style: str</tt> </tt>
<a name="L1481"></a><tt class="py-lineno">1481</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L1482"></a><tt class="py-lineno">1482</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">bib</tt> <tt class="py-op">=</tt> <tt class="py-name">bib</tt> </tt>
<a name="L1483"></a><tt class="py-lineno">1483</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">style</tt> <tt class="py-op">=</tt> <tt class="py-name">style</tt> </tt>
<a name="L1484"></a><tt class="py-lineno">1484</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">tmp_bib</tt> <tt class="py-op">=</tt> <tt class="py-name">copy</tt><tt class="py-op">.</tt><tt class="py-name">deepcopy</tt><tt class="py-op">(</tt><tt class="py-name">bib</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1485"></a><tt class="py-lineno">1485</tt>  <tt class="py-line">     </tt>
<a name="_AddBibtexOutputEnchancer.compute"></a><div id="_AddBibtexOutputEnchancer.compute-def"><a name="L1486"></a><tt class="py-lineno">1486</tt> <a class="py-toggle" href="#" id="_AddBibtexOutputEnchancer.compute-toggle" onclick="return toggle('_AddBibtexOutputEnchancer.compute');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography._AddBibtexOutputEnchancer-class.html#compute">compute</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_AddBibtexOutputEnchancer.compute-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="_AddBibtexOutputEnchancer.compute-expanded"><a name="L1487"></a><tt class="py-lineno">1487</tt>  <tt class="py-line">        <tt class="py-docstring">'''Causes _AddBibtexOutputEnchancer to do its magic.</tt> </tt>
<a name="L1488"></a><tt class="py-lineno">1488</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L1489"></a><tt class="py-lineno">1489</tt>  <tt class="py-line"><tt class="py-docstring">            &gt;&gt;&gt; _AddBibtexOutputEnchancer(some_bib, 'abbrv').compute()</tt> </tt>
<a name="L1490"></a><tt class="py-lineno">1490</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L1491"></a><tt class="py-lineno">1491</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt id="link-186" class="py-name"><a title="bkn.bibtex.utilities.which" class="py-name" href="#" onclick="return doclink('link-186', 'which', 'link-44');">which</a></tt><tt class="py-op">(</tt><tt class="py-string">'bibtex'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1492"></a><tt class="py-lineno">1492</tt>  <tt class="py-line">            <tt class="py-keyword">raise</tt> <tt id="link-187" class="py-name" targets="Class bkn.bibtex.error.ExternalError=bkn.bibtex.error.ExternalError-class.html"><a title="bkn.bibtex.error.ExternalError" class="py-name" href="#" onclick="return doclink('link-187', 'ExternalError', 'link-187');">ExternalError</a></tt><tt class="py-op">(</tt><tt class="py-string">'bibtex executable is not available.'</tt><tt class="py-op">)</tt> </tt>
<a name="L1493"></a><tt class="py-lineno">1493</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">tmp_bib</tt><tt class="py-op">.</tt><tt id="link-188" class="py-name" targets="Method bkn.bibtex.bibliography.Bibliography.assign_numerical_ids()=bkn.bibtex.bibliography.Bibliography-class.html#assign_numerical_ids"><a title="bkn.bibtex.bibliography.Bibliography.assign_numerical_ids" class="py-name" href="#" onclick="return doclink('link-188', 'assign_numerical_ids', 'link-188');">assign_numerical_ids</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1494"></a><tt class="py-lineno">1494</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-189" class="py-name" targets="Method bkn.bibtex.bibliography._AddBibtexOutputEnchancer._prepare_temp_files()=bkn.bibtex.bibliography._AddBibtexOutputEnchancer-class.html#_prepare_temp_files"><a title="bkn.bibtex.bibliography._AddBibtexOutputEnchancer._prepare_temp_files" class="py-name" href="#" onclick="return doclink('link-189', '_prepare_temp_files', 'link-189');">_prepare_temp_files</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1495"></a><tt class="py-lineno">1495</tt>  <tt class="py-line">        <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L1496"></a><tt class="py-lineno">1496</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-190" class="py-name" targets="Method bkn.bibtex.bibliography._AddBibtexOutputEnchancer._create_aux_file()=bkn.bibtex.bibliography._AddBibtexOutputEnchancer-class.html#_create_aux_file"><a title="bkn.bibtex.bibliography._AddBibtexOutputEnchancer._create_aux_file" class="py-name" href="#" onclick="return doclink('link-190', '_create_aux_file', 'link-190');">_create_aux_file</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1497"></a><tt class="py-lineno">1497</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-191" class="py-name" targets="Method bkn.bibtex.bibliography._AddBibtexOutputEnchancer._create_bib_file()=bkn.bibtex.bibliography._AddBibtexOutputEnchancer-class.html#_create_bib_file"><a title="bkn.bibtex.bibliography._AddBibtexOutputEnchancer._create_bib_file" class="py-name" href="#" onclick="return doclink('link-191', '_create_bib_file', 'link-191');">_create_bib_file</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1498"></a><tt class="py-lineno">1498</tt>  <tt class="py-line">            <tt class="py-op">(</tt><tt class="py-name">stdout</tt><tt class="py-op">,</tt> <tt class="py-name">bbl</tt><tt class="py-op">)</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-192" class="py-name" targets="Method bkn.bibtex.bibliography._AddBibtexOutputEnchancer._run_bibtex()=bkn.bibtex.bibliography._AddBibtexOutputEnchancer-class.html#_run_bibtex"><a title="bkn.bibtex.bibliography._AddBibtexOutputEnchancer._run_bibtex" class="py-name" href="#" onclick="return doclink('link-192', '_run_bibtex', 'link-192');">_run_bibtex</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1499"></a><tt class="py-lineno">1499</tt>  <tt class="py-line">            <tt class="py-name">warnings_dict</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-193" class="py-name" targets="Method bkn.bibtex.bibliography._AddBibtexOutputEnchancer._extract_bibtex_warnings()=bkn.bibtex.bibliography._AddBibtexOutputEnchancer-class.html#_extract_bibtex_warnings"><a title="bkn.bibtex.bibliography._AddBibtexOutputEnchancer._extract_bibtex_warnings" class="py-name" href="#" onclick="return doclink('link-193', '_extract_bibtex_warnings', 'link-193');">_extract_bibtex_warnings</a></tt><tt class="py-op">(</tt><tt class="py-name">stdout</tt><tt class="py-op">)</tt> </tt>
<a name="L1500"></a><tt class="py-lineno">1500</tt>  <tt class="py-line">            <tt class="py-name">bbl_dict</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-194" class="py-name" targets="Method bkn.bibtex.bibliography._AddBibtexOutputEnchancer._extract_bibitems()=bkn.bibtex.bibliography._AddBibtexOutputEnchancer-class.html#_extract_bibitems"><a title="bkn.bibtex.bibliography._AddBibtexOutputEnchancer._extract_bibitems" class="py-name" href="#" onclick="return doclink('link-194', '_extract_bibitems', 'link-194');">_extract_bibitems</a></tt><tt class="py-op">(</tt><tt class="py-name">bbl</tt><tt class="py-op">)</tt> </tt>
<a name="L1501"></a><tt class="py-lineno">1501</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-195" class="py-name" targets="Method bkn.bibtex.bibliography._AddBibtexOutputEnchancer._enchance_with_warnings()=bkn.bibtex.bibliography._AddBibtexOutputEnchancer-class.html#_enchance_with_warnings"><a title="bkn.bibtex.bibliography._AddBibtexOutputEnchancer._enchance_with_warnings" class="py-name" href="#" onclick="return doclink('link-195', '_enchance_with_warnings', 'link-195');">_enchance_with_warnings</a></tt><tt class="py-op">(</tt><tt class="py-name">warnings_dict</tt><tt class="py-op">)</tt> </tt>
<a name="L1502"></a><tt class="py-lineno">1502</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-196" class="py-name" targets="Method bkn.bibtex.bibliography._AddBibtexOutputEnchancer._enchance_with_citations()=bkn.bibtex.bibliography._AddBibtexOutputEnchancer-class.html#_enchance_with_citations"><a title="bkn.bibtex.bibliography._AddBibtexOutputEnchancer._enchance_with_citations" class="py-name" href="#" onclick="return doclink('link-196', '_enchance_with_citations', 'link-196');">_enchance_with_citations</a></tt><tt class="py-op">(</tt><tt class="py-name">bbl_dict</tt><tt class="py-op">)</tt>                 </tt>
<a name="L1503"></a><tt class="py-lineno">1503</tt>  <tt class="py-line">        <tt class="py-keyword">finally</tt><tt class="py-op">:</tt> </tt>
<a name="L1504"></a><tt class="py-lineno">1504</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-197" class="py-name" targets="Method bkn.bibtex.bibliography._AddBibtexOutputEnchancer._clean_up_temp_files()=bkn.bibtex.bibliography._AddBibtexOutputEnchancer-class.html#_clean_up_temp_files"><a title="bkn.bibtex.bibliography._AddBibtexOutputEnchancer._clean_up_temp_files" class="py-name" href="#" onclick="return doclink('link-197', '_clean_up_temp_files', 'link-197');">_clean_up_temp_files</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1505"></a><tt class="py-lineno">1505</tt>  <tt class="py-line">     </tt>
<a name="_AddBibtexOutputEnchancer._enchance_with_warnings"></a><div id="_AddBibtexOutputEnchancer._enchance_with_warnings-def"><a name="L1506"></a><tt class="py-lineno">1506</tt> <a class="py-toggle" href="#" id="_AddBibtexOutputEnchancer._enchance_with_warnings-toggle" onclick="return toggle('_AddBibtexOutputEnchancer._enchance_with_warnings');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography._AddBibtexOutputEnchancer-class.html#_enchance_with_warnings">_enchance_with_warnings</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">warnings_dict</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_AddBibtexOutputEnchancer._enchance_with_warnings-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="_AddBibtexOutputEnchancer._enchance_with_warnings-expanded"><a name="L1507"></a><tt class="py-lineno">1507</tt>  <tt class="py-line">        <tt class="py-keyword">for</tt> <tt class="py-name">i</tt> <tt class="py-keyword">in</tt> <tt class="py-name">range</tt><tt class="py-op">(</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">bib</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1508"></a><tt class="py-lineno">1508</tt>  <tt class="py-line">            <tt class="py-name">key</tt> <tt class="py-op">=</tt> <tt class="py-name">i</tt><tt class="py-op">.</tt><tt id="link-198" class="py-name" targets="Method bkn.bibtex.bibliography.Bibliography.__str__()=bkn.bibtex.bibliography.Bibliography-class.html#__str__,Method bkn.bibtex.bibliography.Record.__str__()=bkn.bibtex.bibliography.Record-class.html#__str__,Method bkn.bibtex.error.AttributeCollisionWarning.__str__()=bkn.bibtex.error.AttributeCollisionWarning-class.html#__str__,Method bkn.bibtex.error.BibFileSyntaxError.__str__()=bkn.bibtex.error.BibFileSyntaxError-class.html#__str__,Method bkn.bibtex.error.FormatNotSupportedError.__str__()=bkn.bibtex.error.FormatNotSupportedError-class.html#__str__"><a title="bkn.bibtex.bibliography.Bibliography.__str__
bkn.bibtex.bibliography.Record.__str__
bkn.bibtex.error.AttributeCollisionWarning.__str__
bkn.bibtex.error.BibFileSyntaxError.__str__
bkn.bibtex.error.FormatNotSupportedError.__str__" class="py-name" href="#" onclick="return doclink('link-198', '__str__', 'link-198');">__str__</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1509"></a><tt class="py-lineno">1509</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">warnings_dict</tt><tt class="py-op">.</tt><tt class="py-name">has_key</tt><tt class="py-op">(</tt><tt class="py-name">key</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1510"></a><tt class="py-lineno">1510</tt>  <tt class="py-line">                <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">bib</tt><tt class="py-op">.</tt><tt class="py-name">record_list</tt><tt class="py-op">[</tt><tt class="py-name">i</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">bibtex_warnings</tt> <tt class="py-op">=</tt> <tt class="py-name">warnings_dict</tt><tt class="py-op">[</tt><tt class="py-name">key</tt><tt class="py-op">]</tt> </tt>
<a name="L1511"></a><tt class="py-lineno">1511</tt>  <tt class="py-line">            <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1512"></a><tt class="py-lineno">1512</tt>  <tt class="py-line">                <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">bib</tt><tt class="py-op">.</tt><tt class="py-name">record_list</tt><tt class="py-op">[</tt><tt class="py-name">i</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">bibtex_warnings</tt> <tt class="py-op">=</tt> <tt class="py-string">''</tt> </tt>
</div><a name="L1513"></a><tt class="py-lineno">1513</tt>  <tt class="py-line">     </tt>
<a name="_AddBibtexOutputEnchancer._enchance_with_citations"></a><div id="_AddBibtexOutputEnchancer._enchance_with_citations-def"><a name="L1514"></a><tt class="py-lineno">1514</tt> <a class="py-toggle" href="#" id="_AddBibtexOutputEnchancer._enchance_with_citations-toggle" onclick="return toggle('_AddBibtexOutputEnchancer._enchance_with_citations');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography._AddBibtexOutputEnchancer-class.html#_enchance_with_citations">_enchance_with_citations</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">bbl_dict</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_AddBibtexOutputEnchancer._enchance_with_citations-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="_AddBibtexOutputEnchancer._enchance_with_citations-expanded"><a name="L1515"></a><tt class="py-lineno">1515</tt>  <tt class="py-line">        <tt class="py-keyword">for</tt> <tt class="py-name">i</tt> <tt class="py-keyword">in</tt> <tt class="py-name">range</tt><tt class="py-op">(</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">bib</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1516"></a><tt class="py-lineno">1516</tt>  <tt class="py-line">            <tt class="py-name">key</tt> <tt class="py-op">=</tt> <tt class="py-name">i</tt><tt class="py-op">.</tt><tt id="link-199" class="py-name"><a title="bkn.bibtex.bibliography.Bibliography.__str__
bkn.bibtex.bibliography.Record.__str__
bkn.bibtex.error.AttributeCollisionWarning.__str__
bkn.bibtex.error.BibFileSyntaxError.__str__
bkn.bibtex.error.FormatNotSupportedError.__str__" class="py-name" href="#" onclick="return doclink('link-199', '__str__', 'link-198');">__str__</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1517"></a><tt class="py-lineno">1517</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">bib</tt><tt class="py-op">.</tt><tt class="py-name">record_list</tt><tt class="py-op">[</tt><tt class="py-name">i</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">bibtex_out</tt> <tt class="py-op">=</tt> <tt class="py-name">bbl_dict</tt><tt class="py-op">[</tt><tt class="py-name">key</tt><tt class="py-op">]</tt> </tt>
</div><a name="L1518"></a><tt class="py-lineno">1518</tt>  <tt class="py-line">     </tt>
<a name="_AddBibtexOutputEnchancer._create_aux_file"></a><div id="_AddBibtexOutputEnchancer._create_aux_file-def"><a name="L1519"></a><tt class="py-lineno">1519</tt> <a class="py-toggle" href="#" id="_AddBibtexOutputEnchancer._create_aux_file-toggle" onclick="return toggle('_AddBibtexOutputEnchancer._create_aux_file');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography._AddBibtexOutputEnchancer-class.html#_create_aux_file">_create_aux_file</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_AddBibtexOutputEnchancer._create_aux_file-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="_AddBibtexOutputEnchancer._create_aux_file-expanded"><a name="L1520"></a><tt class="py-lineno">1520</tt>  <tt class="py-line">        <tt class="py-keyword">with</tt> <tt class="py-name">codecs</tt><tt class="py-op">.</tt><tt class="py-name">open</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">aux_file</tt><tt class="py-op">,</tt> <tt class="py-string">'w'</tt><tt class="py-op">,</tt> <tt class="py-string">'ascii'</tt><tt class="py-op">)</tt> <tt class="py-keyword">as</tt> <tt class="py-name">f</tt><tt class="py-op">:</tt> </tt>
<a name="L1521"></a><tt class="py-lineno">1521</tt>  <tt class="py-line">            <tt class="py-name">f</tt><tt class="py-op">.</tt><tt class="py-name">write</tt><tt class="py-op">(</tt><tt class="py-string">'''\\citation{*}\n\\bibdata{tmp}\n\\bibstyle{'''</tt> <tt class="py-op">+</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">style</tt> <tt class="py-op">+</tt> <tt class="py-string">'}'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1522"></a><tt class="py-lineno">1522</tt>  <tt class="py-line">     </tt>
<a name="_AddBibtexOutputEnchancer._create_bib_file"></a><div id="_AddBibtexOutputEnchancer._create_bib_file-def"><a name="L1523"></a><tt class="py-lineno">1523</tt> <a class="py-toggle" href="#" id="_AddBibtexOutputEnchancer._create_bib_file-toggle" onclick="return toggle('_AddBibtexOutputEnchancer._create_bib_file');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography._AddBibtexOutputEnchancer-class.html#_create_bib_file">_create_bib_file</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_AddBibtexOutputEnchancer._create_bib_file-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="_AddBibtexOutputEnchancer._create_bib_file-expanded"><a name="L1524"></a><tt class="py-lineno">1524</tt>  <tt class="py-line">        <tt class="py-keyword">with</tt> <tt class="py-name">codecs</tt><tt class="py-op">.</tt><tt class="py-name">open</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">bib_file</tt><tt class="py-op">,</tt> <tt class="py-string">'w'</tt><tt class="py-op">,</tt> <tt id="link-200" class="py-name"><a title="bkn.bibtex.bibliography.DEFAULT_ENCODING" class="py-name" href="#" onclick="return doclink('link-200', 'DEFAULT_ENCODING', 'link-48');">DEFAULT_ENCODING</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">as</tt> <tt class="py-name">f</tt><tt class="py-op">:</tt> </tt>
<a name="L1525"></a><tt class="py-lineno">1525</tt>  <tt class="py-line">            <tt class="py-name">f</tt><tt class="py-op">.</tt><tt class="py-name">write</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">tmp_bib</tt><tt class="py-op">.</tt><tt id="link-201" class="py-name"><a title="bkn.bibtex.bibliography.Bibliography.to_bibtex
bkn.bibtex.bibliography.Record.to_bibtex" class="py-name" href="#" onclick="return doclink('link-201', 'to_bibtex', 'link-82');">to_bibtex</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1526"></a><tt class="py-lineno">1526</tt>  <tt class="py-line">     </tt>
<a name="_AddBibtexOutputEnchancer._run_bibtex"></a><div id="_AddBibtexOutputEnchancer._run_bibtex-def"><a name="L1527"></a><tt class="py-lineno">1527</tt> <a class="py-toggle" href="#" id="_AddBibtexOutputEnchancer._run_bibtex-toggle" onclick="return toggle('_AddBibtexOutputEnchancer._run_bibtex');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography._AddBibtexOutputEnchancer-class.html#_run_bibtex">_run_bibtex</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_AddBibtexOutputEnchancer._run_bibtex-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="_AddBibtexOutputEnchancer._run_bibtex-expanded"><a name="L1528"></a><tt class="py-lineno">1528</tt>  <tt class="py-line">        <tt class="py-name">sp</tt> <tt class="py-op">=</tt> <tt class="py-name">subprocess</tt><tt class="py-op">.</tt><tt class="py-name">Popen</tt><tt class="py-op">(</tt> </tt>
<a name="L1529"></a><tt class="py-lineno">1529</tt>  <tt class="py-line">          <tt class="py-op">[</tt><tt class="py-string">'bibtex'</tt><tt class="py-op">,</tt> <tt class="py-string">'tmp'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt>
<a name="L1530"></a><tt class="py-lineno">1530</tt>  <tt class="py-line">          <tt class="py-name">stdout</tt><tt class="py-op">=</tt><tt class="py-name">subprocess</tt><tt class="py-op">.</tt><tt class="py-name">PIPE</tt> </tt>
<a name="L1531"></a><tt class="py-lineno">1531</tt>  <tt class="py-line">          <tt class="py-op">)</tt> </tt>
<a name="L1532"></a><tt class="py-lineno">1532</tt>  <tt class="py-line">        <tt class="py-name">sp</tt><tt class="py-op">.</tt><tt class="py-name">wait</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1533"></a><tt class="py-lineno">1533</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">sp</tt><tt class="py-op">.</tt><tt class="py-name">returncode</tt> <tt class="py-op">!=</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L1534"></a><tt class="py-lineno">1534</tt>  <tt class="py-line">            <tt class="py-keyword">raise</tt> <tt id="link-202" class="py-name"><a title="bkn.bibtex.error.BibTeXError" class="py-name" href="#" onclick="return doclink('link-202', 'BibTeXError', 'link-20');">BibTeXError</a></tt><tt class="py-op">(</tt> </tt>
<a name="L1535"></a><tt class="py-lineno">1535</tt>  <tt class="py-line">               <tt class="py-string">'Running bibtex failed. BibTeXoutput follows: '</tt> <tt class="py-op">+</tt> </tt>
<a name="L1536"></a><tt class="py-lineno">1536</tt>  <tt class="py-line">               <tt class="py-name">sp</tt><tt class="py-op">.</tt><tt class="py-name">stdout</tt><tt class="py-op">.</tt><tt class="py-name">read</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1537"></a><tt class="py-lineno">1537</tt>  <tt class="py-line">               <tt class="py-op">)</tt> </tt>
<a name="L1538"></a><tt class="py-lineno">1538</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">path</tt><tt class="py-op">.</tt><tt class="py-name">exists</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">bbl_file</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1539"></a><tt class="py-lineno">1539</tt>  <tt class="py-line">            <tt class="py-keyword">raise</tt> <tt id="link-203" class="py-name"><a title="bkn.bibtex.error.ExternalError" class="py-name" href="#" onclick="return doclink('link-203', 'ExternalError', 'link-187');">ExternalError</a></tt><tt class="py-op">(</tt><tt class="py-string">'bibtex failed to produce bbl_file'</tt><tt class="py-op">)</tt> </tt>
<a name="L1540"></a><tt class="py-lineno">1540</tt>  <tt class="py-line">         </tt>
<a name="L1541"></a><tt class="py-lineno">1541</tt>  <tt class="py-line">        <tt class="py-keyword">with</tt> <tt class="py-name">codecs</tt><tt class="py-op">.</tt><tt class="py-name">open</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">bbl_file</tt><tt class="py-op">,</tt> <tt class="py-string">'r'</tt><tt class="py-op">,</tt> <tt id="link-204" class="py-name"><a title="bkn.bibtex.bibliography.DEFAULT_ENCODING" class="py-name" href="#" onclick="return doclink('link-204', 'DEFAULT_ENCODING', 'link-48');">DEFAULT_ENCODING</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">as</tt> <tt class="py-name">f</tt><tt class="py-op">:</tt> </tt>
<a name="L1542"></a><tt class="py-lineno">1542</tt>  <tt class="py-line">            <tt class="py-name">bbl</tt> <tt class="py-op">=</tt> <tt class="py-name">f</tt><tt class="py-op">.</tt><tt class="py-name">read</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1543"></a><tt class="py-lineno">1543</tt>  <tt class="py-line">             </tt>
<a name="L1544"></a><tt class="py-lineno">1544</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-name">sp</tt><tt class="py-op">.</tt><tt class="py-name">stdout</tt><tt class="py-op">,</tt> <tt class="py-name">bbl</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1545"></a><tt class="py-lineno">1545</tt>  <tt class="py-line">     </tt>
<a name="_AddBibtexOutputEnchancer._extract_bibtex_warnings"></a><div id="_AddBibtexOutputEnchancer._extract_bibtex_warnings-def"><a name="L1546"></a><tt class="py-lineno">1546</tt> <a class="py-toggle" href="#" id="_AddBibtexOutputEnchancer._extract_bibtex_warnings-toggle" onclick="return toggle('_AddBibtexOutputEnchancer._extract_bibtex_warnings');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography._AddBibtexOutputEnchancer-class.html#_extract_bibtex_warnings">_extract_bibtex_warnings</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">bibtex_output</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_AddBibtexOutputEnchancer._extract_bibtex_warnings-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="_AddBibtexOutputEnchancer._extract_bibtex_warnings-expanded"><a name="L1547"></a><tt class="py-lineno">1547</tt>  <tt class="py-line">        <tt class="py-name">result</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L1548"></a><tt class="py-lineno">1548</tt>  <tt class="py-line">        <tt class="py-keyword">for</tt> <tt class="py-name">line</tt> <tt class="py-keyword">in</tt> <tt class="py-name">bibtex_output</tt><tt class="py-op">:</tt> </tt>
<a name="L1549"></a><tt class="py-lineno">1549</tt>  <tt class="py-line">            <tt class="py-name">m</tt> <tt class="py-op">=</tt> <tt id="link-205" class="py-name"><a title="bkn.bibtex.bibliography.BIBTEX_WARNING_REGEX" class="py-name" href="#" onclick="return doclink('link-205', 'BIBTEX_WARNING_REGEX', 'link-47');">BIBTEX_WARNING_REGEX</a></tt><tt class="py-op">.</tt><tt class="py-name">match</tt><tt class="py-op">(</tt><tt class="py-name">line</tt><tt class="py-op">)</tt> </tt>
<a name="L1550"></a><tt class="py-lineno">1550</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">m</tt><tt class="py-op">:</tt> </tt>
<a name="L1551"></a><tt class="py-lineno">1551</tt>  <tt class="py-line">                <tt class="py-op">(</tt><tt class="py-name">warning</tt><tt class="py-op">,</tt> <tt class="py-name">key</tt><tt class="py-op">)</tt> <tt class="py-op">=</tt> <tt class="py-name">m</tt><tt class="py-op">.</tt><tt id="link-206" class="py-name" targets="Function bkn.bibtex.utilities.group()=bkn.bibtex.utilities-module.html#group"><a title="bkn.bibtex.utilities.group" class="py-name" href="#" onclick="return doclink('link-206', 'group', 'link-206');">group</a></tt><tt class="py-op">(</tt><tt class="py-number">1</tt><tt class="py-op">,</tt> <tt class="py-number">2</tt><tt class="py-op">)</tt> </tt>
<a name="L1552"></a><tt class="py-lineno">1552</tt>  <tt class="py-line">                <tt class="py-name">result</tt><tt class="py-op">.</tt><tt class="py-name">setdefault</tt><tt class="py-op">(</tt><tt class="py-name">key</tt><tt class="py-op">,</tt><tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt id="link-207" class="py-name"><a title="bkn.bibtex.bibliography.Bibliography.append" class="py-name" href="#" onclick="return doclink('link-207', 'append', 'link-157');">append</a></tt><tt class="py-op">(</tt><tt class="py-name">warning</tt><tt class="py-op">)</tt> </tt>
<a name="L1553"></a><tt class="py-lineno">1553</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">result</tt> </tt>
</div><a name="L1554"></a><tt class="py-lineno">1554</tt>  <tt class="py-line">     </tt>
<a name="_AddBibtexOutputEnchancer._extract_bibitems"></a><div id="_AddBibtexOutputEnchancer._extract_bibitems-def"><a name="L1555"></a><tt class="py-lineno">1555</tt> <a class="py-toggle" href="#" id="_AddBibtexOutputEnchancer._extract_bibitems-toggle" onclick="return toggle('_AddBibtexOutputEnchancer._extract_bibitems');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography._AddBibtexOutputEnchancer-class.html#_extract_bibitems">_extract_bibitems</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">bbl</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_AddBibtexOutputEnchancer._extract_bibitems-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="_AddBibtexOutputEnchancer._extract_bibitems-expanded"><a name="L1556"></a><tt class="py-lineno">1556</tt>  <tt class="py-line">        <tt class="py-name">result</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L1557"></a><tt class="py-lineno">1557</tt>  <tt class="py-line">        <tt class="py-name">bbl</tt> <tt class="py-op">=</tt> <tt class="py-name">bbl</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">r'\end{thebibliography}'</tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
<a name="L1558"></a><tt class="py-lineno">1558</tt>  <tt class="py-line">        <tt class="py-name">items</tt> <tt class="py-op">=</tt> <tt class="py-name">bbl</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">r'\bibitem{'</tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> </tt>
<a name="L1559"></a><tt class="py-lineno">1559</tt>  <tt class="py-line">        <tt class="py-keyword">for</tt> <tt class="py-name">item</tt> <tt class="py-keyword">in</tt> <tt class="py-name">items</tt><tt class="py-op">:</tt> </tt>
<a name="L1560"></a><tt class="py-lineno">1560</tt>  <tt class="py-line">            <tt class="py-name">key</tt><tt class="py-op">,</tt> <tt class="py-name">value</tt> <tt class="py-op">=</tt> <tt class="py-name">item</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">'}'</tt><tt class="py-op">,</tt><tt class="py-number">1</tt><tt class="py-op">)</tt> </tt>
<a name="L1561"></a><tt class="py-lineno">1561</tt>  <tt class="py-line">            <tt class="py-name">result</tt><tt class="py-op">[</tt><tt class="py-name">key</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">value</tt> </tt>
<a name="L1562"></a><tt class="py-lineno">1562</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">result</tt> </tt>
</div><a name="L1563"></a><tt class="py-lineno">1563</tt>  <tt class="py-line">     </tt>
<a name="_AddBibtexOutputEnchancer._prepare_temp_files"></a><div id="_AddBibtexOutputEnchancer._prepare_temp_files-def"><a name="L1564"></a><tt class="py-lineno">1564</tt> <a class="py-toggle" href="#" id="_AddBibtexOutputEnchancer._prepare_temp_files-toggle" onclick="return toggle('_AddBibtexOutputEnchancer._prepare_temp_files');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography._AddBibtexOutputEnchancer-class.html#_prepare_temp_files">_prepare_temp_files</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_AddBibtexOutputEnchancer._prepare_temp_files-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="_AddBibtexOutputEnchancer._prepare_temp_files-expanded"><a name="L1565"></a><tt class="py-lineno">1565</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">tmp_dr</tt> <tt class="py-op">=</tt> <tt class="py-name">tempfile</tt><tt class="py-op">.</tt><tt class="py-name">mkdtemp</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1566"></a><tt class="py-lineno">1566</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">wrk_dr</tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">getcwd</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-comment"># we need to restore this when we finish!</tt> </tt>
<a name="L1567"></a><tt class="py-lineno">1567</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">bbl_file</tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">path</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">tmp_dr</tt><tt class="py-op">,</tt> <tt class="py-string">'tmp.bbl'</tt><tt class="py-op">)</tt> </tt>
<a name="L1568"></a><tt class="py-lineno">1568</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">bib_file</tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">path</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">tmp_dr</tt><tt class="py-op">,</tt> <tt class="py-string">'tmp.bib'</tt><tt class="py-op">)</tt> </tt>
<a name="L1569"></a><tt class="py-lineno">1569</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">aux_file</tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">path</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">tmp_dr</tt><tt class="py-op">,</tt> <tt class="py-string">'tmp.aux'</tt><tt class="py-op">)</tt> </tt>
<a name="L1570"></a><tt class="py-lineno">1570</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">blg_file</tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">path</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">tmp_dr</tt><tt class="py-op">,</tt> <tt class="py-string">'tmp.blg'</tt><tt class="py-op">)</tt> </tt>
<a name="L1571"></a><tt class="py-lineno">1571</tt>  <tt class="py-line">        <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">chdir</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">tmp_dr</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1572"></a><tt class="py-lineno">1572</tt>  <tt class="py-line">     </tt>
<a name="_AddBibtexOutputEnchancer._clean_up_temp_files"></a><div id="_AddBibtexOutputEnchancer._clean_up_temp_files-def"><a name="L1573"></a><tt class="py-lineno">1573</tt> <a class="py-toggle" href="#" id="_AddBibtexOutputEnchancer._clean_up_temp_files-toggle" onclick="return toggle('_AddBibtexOutputEnchancer._clean_up_temp_files');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="bkn.bibtex.bibliography._AddBibtexOutputEnchancer-class.html#_clean_up_temp_files">_clean_up_temp_files</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_AddBibtexOutputEnchancer._clean_up_temp_files-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="_AddBibtexOutputEnchancer._clean_up_temp_files-expanded"><a name="L1574"></a><tt class="py-lineno">1574</tt>  <tt class="py-line">        <tt class="py-comment"># We must enclose these os.remove commands in try clauses to</tt> </tt>
<a name="L1575"></a><tt class="py-lineno">1575</tt>  <tt class="py-line">        <tt class="py-comment"># prevent errors here from masking earlier problems</tt> </tt>
<a name="L1576"></a><tt class="py-lineno">1576</tt>  <tt class="py-line">        <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L1577"></a><tt class="py-lineno">1577</tt>  <tt class="py-line">            <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-208" class="py-name"><a title="bkn.bibtex.bibliography.Bibliography.remove" class="py-name" href="#" onclick="return doclink('link-208', 'remove', 'link-160');">remove</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">bbl_file</tt><tt class="py-op">)</tt> </tt>
<a name="L1578"></a><tt class="py-lineno">1578</tt>  <tt class="py-line">        <tt class="py-keyword">except</tt> <tt class="py-name">OSError</tt><tt class="py-op">:</tt> </tt>
<a name="L1579"></a><tt class="py-lineno">1579</tt>  <tt class="py-line">            <tt class="py-keyword">pass</tt> </tt>
<a name="L1580"></a><tt class="py-lineno">1580</tt>  <tt class="py-line">        <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L1581"></a><tt class="py-lineno">1581</tt>  <tt class="py-line">            <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-209" class="py-name"><a title="bkn.bibtex.bibliography.Bibliography.remove" class="py-name" href="#" onclick="return doclink('link-209', 'remove', 'link-160');">remove</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">aux_file</tt><tt class="py-op">)</tt> </tt>
<a name="L1582"></a><tt class="py-lineno">1582</tt>  <tt class="py-line">        <tt class="py-keyword">except</tt> <tt class="py-name">OSError</tt><tt class="py-op">:</tt> </tt>
<a name="L1583"></a><tt class="py-lineno">1583</tt>  <tt class="py-line">            <tt class="py-keyword">pass</tt> </tt>
<a name="L1584"></a><tt class="py-lineno">1584</tt>  <tt class="py-line">        <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L1585"></a><tt class="py-lineno">1585</tt>  <tt class="py-line">            <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-210" class="py-name"><a title="bkn.bibtex.bibliography.Bibliography.remove" class="py-name" href="#" onclick="return doclink('link-210', 'remove', 'link-160');">remove</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">bib_file</tt><tt class="py-op">)</tt> </tt>
<a name="L1586"></a><tt class="py-lineno">1586</tt>  <tt class="py-line">        <tt class="py-keyword">except</tt> <tt class="py-name">OSError</tt><tt class="py-op">:</tt> </tt>
<a name="L1587"></a><tt class="py-lineno">1587</tt>  <tt class="py-line">            <tt class="py-keyword">pass</tt> </tt>
<a name="L1588"></a><tt class="py-lineno">1588</tt>  <tt class="py-line">        <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L1589"></a><tt class="py-lineno">1589</tt>  <tt class="py-line">            <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-211" class="py-name"><a title="bkn.bibtex.bibliography.Bibliography.remove" class="py-name" href="#" onclick="return doclink('link-211', 'remove', 'link-160');">remove</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">blg_file</tt><tt class="py-op">)</tt> </tt>
<a name="L1590"></a><tt class="py-lineno">1590</tt>  <tt class="py-line">        <tt class="py-keyword">except</tt> <tt class="py-name">OSError</tt><tt class="py-op">:</tt> </tt>
<a name="L1591"></a><tt class="py-lineno">1591</tt>  <tt class="py-line">            <tt class="py-keyword">pass</tt> </tt>
<a name="L1592"></a><tt class="py-lineno">1592</tt>  <tt class="py-line">        <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">removedirs</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">tmp_dr</tt><tt class="py-op">)</tt> </tt>
<a name="L1593"></a><tt class="py-lineno">1593</tt>  <tt class="py-line">        <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">chdir</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">wrk_dr</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L1594"></a><tt class="py-lineno">1594</tt>  <tt class="py-line"> </tt><script type="text/javascript">
<!--
expandto(location.href);
// -->
</script>
</pre>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="bkn.bibtex-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/bibkn/">bkn.bibtex</a></th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Sun Jul  4 23:10:59 2010
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
